Package io.envoyproxy.envoy.service.rate_limit_quota.v3

Class RateLimitQuotaResponse.BucketAction.AbandonAction.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaResponse.BucketAction.AbandonActionOrBuilder, java.lang.Cloneable
    Enclosing class:
    RateLimitQuotaResponse.BucketAction.AbandonAction
    public static final class RateLimitQuotaResponse.BucketAction.AbandonAction.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaResponse.BucketAction.AbandonAction.Builder>
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