Class RateLimitQuotaResponse.BucketAction.AbandonAction

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaResponse.BucketAction.AbandonActionOrBuilder, java.io.Serializable
    Enclosing class:
    RateLimitQuotaResponse.BucketAction

    public static final class RateLimitQuotaResponse.BucketAction.AbandonAction
    extends com.google.protobuf.GeneratedMessage
    implements RateLimitQuotaResponse.BucketAction.AbandonActionOrBuilder
     Abandon action for the bucket. Indicates that the RLQS server will no longer be
     sending updates for the given :ref:`bucket_id
     <envoy_v3_api_field_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.bucket_id>`.
    
     If no requests are reported for a bucket, after some time the server considers the bucket
     inactive. The server stops tracking the bucket, and instructs the the data plane to abandon
     the bucket via this message.
    
     **Abandoning the assignment**
    
     The data plane is to erase the bucket (including its usage data) from the memory.
     It should stop tracking the bucket, and stop reporting its usage. This effectively resets
     the data plane to the state prior to matching the first request into the bucket.
    
     **Restarting the subscription**
    
     If a new request is matched into a bucket previously abandoned, the data plane must behave
     as if it has never tracked the bucket, and it's the first request matched into it:
    
     1. The process of :ref:`subscription and reporting
     <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.reporting_interval>`
     starts from the beginning.
    
     2. The bucket transitions to the :ref:`"no assignment"
     <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.no_assignment_behavior>`
     state.
    
     3. Once the new assignment is received, it's applied per
     "Applying the first assignment to the bucket" section of the :ref:`QuotaAssignmentAction
     <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`.
     
    Protobuf type envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction
    See Also:
    Serialized Form
    • Constructor Detail

      • AbandonAction

        private AbandonAction​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • AbandonAction

        private AbandonAction()
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static RateLimitQuotaResponse.BucketAction.AbandonAction parseFrom​(java.nio.ByteBuffer data,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RateLimitQuotaResponse.BucketAction.AbandonAction parseFrom​(com.google.protobuf.ByteString data)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RateLimitQuotaResponse.BucketAction.AbandonAction parseFrom​(com.google.protobuf.ByteString data,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RateLimitQuotaResponse.BucketAction.AbandonAction parseFrom​(byte[] data,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseDelimitedFrom

        public static RateLimitQuotaResponse.BucketAction.AbandonAction parseDelimitedFrom​(java.io.InputStream input,
                                                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimitQuotaResponse.BucketAction.AbandonAction parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • getParserForType

        public com.google.protobuf.Parser<RateLimitQuotaResponse.BucketAction.AbandonAction> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage
      • getDefaultInstanceForType

        public RateLimitQuotaResponse.BucketAction.AbandonAction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder