Package io.envoyproxy.envoy.extensions.filters.http.rate_limit_quota.v3

Class RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder

    • Method Detail

      • getDescriptor

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder>

      • getDefaultInstanceForType

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • hasExpiredAssignmentBehaviorTimeout

        public boolean hasExpiredAssignmentBehaviorTimeout()
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }
        Specified by:
        hasExpiredAssignmentBehaviorTimeout in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder
        Returns:
        Whether the expiredAssignmentBehaviorTimeout field is set.

      • getExpiredAssignmentBehaviorTimeout

        public com.google.protobuf.Duration getExpiredAssignmentBehaviorTimeout()
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }
        Specified by:
        getExpiredAssignmentBehaviorTimeout in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder
        Returns:
        The expiredAssignmentBehaviorTimeout.

      • setExpiredAssignmentBehaviorTimeout

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder setExpiredAssignmentBehaviorTimeout​(com.google.protobuf.Duration value)
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }

      • setExpiredAssignmentBehaviorTimeout

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder setExpiredAssignmentBehaviorTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }

      • mergeExpiredAssignmentBehaviorTimeout

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder mergeExpiredAssignmentBehaviorTimeout​(com.google.protobuf.Duration value)
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }

      • clearExpiredAssignmentBehaviorTimeout

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder clearExpiredAssignmentBehaviorTimeout()
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }

      • getExpiredAssignmentBehaviorTimeoutBuilder

        public com.google.protobuf.Duration.Builder getExpiredAssignmentBehaviorTimeoutBuilder()
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }

      • getExpiredAssignmentBehaviorTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getExpiredAssignmentBehaviorTimeoutOrBuilder()
         Limit the time :ref:`ExpiredAssignmentBehavior
 <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`
 is applied. If the server doesn't respond within this duration:
 1. Selected ``ExpiredAssignmentBehavior`` is no longer applied.
 2. The bucket is abandoned. The process of abandoning the bucket is described in the
    :ref:`AbandonAction <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 3. If a new request is matched into the bucket that has become abandoned,
    the data plane restarts the subscription to the bucket. The process of restarting the
    subscription is described in the :ref:`AbandonAction
    <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
    message.
 If the field is not set, the ``ExpiredAssignmentBehavior`` time is **not limited**:
 it applies to the bucket until replaced by an ``active`` assignment.
        .google.protobuf.Duration expired_assignment_behavior_timeout = 1 [(.validate.rules) = { ... }
        Specified by:
        getExpiredAssignmentBehaviorTimeoutOrBuilder in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder

      • hasFallbackRateLimit

        public boolean hasFallbackRateLimit()
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;
        Specified by:
        hasFallbackRateLimit in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder
        Returns:
        Whether the fallbackRateLimit field is set.

      • getFallbackRateLimit

        public RateLimitStrategy getFallbackRateLimit()
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;
        Specified by:
        getFallbackRateLimit in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder
        Returns:
        The fallbackRateLimit.

      • setFallbackRateLimit

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder setFallbackRateLimit​(RateLimitStrategy value)
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;

      • setFallbackRateLimit

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder setFallbackRateLimit​(RateLimitStrategy.Builder builderForValue)
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;

      • mergeFallbackRateLimit

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder mergeFallbackRateLimit​(RateLimitStrategy value)
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;

      • clearFallbackRateLimit

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder clearFallbackRateLimit()
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;

      • getFallbackRateLimitBuilder

        public RateLimitStrategy.Builder getFallbackRateLimitBuilder()
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;

      • getFallbackRateLimitOrBuilder

        public RateLimitStrategyOrBuilder getFallbackRateLimitOrBuilder()
         Apply the rate limiting strategy to all requests matched into the bucket until the RLQS
 server sends a new assignment, or the :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.type.v3.RateLimitStrategy fallback_rate_limit = 2;
        Specified by:
        getFallbackRateLimitOrBuilder in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder

      • hasReuseLastAssignment

        public boolean hasReuseLastAssignment()
         Reuse the last ``active`` assignment until the RLQS server sends a new assignment, or the
 :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignment reuse_last_assignment = 3;
        Specified by:
        hasReuseLastAssignment in interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder
        Returns:
        Whether the reuseLastAssignment field is set.

      • clearReuseLastAssignment

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.Builder clearReuseLastAssignment()
         Reuse the last ``active`` assignment until the RLQS server sends a new assignment, or the
 :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignment reuse_last_assignment = 3;

      • getReuseLastAssignmentBuilder

        public RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignment.Builder getReuseLastAssignmentBuilder()
         Reuse the last ``active`` assignment until the RLQS server sends a new assignment, or the
 :ref:`expired_assignment_behavior_timeout
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
 runs out.
        .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignment reuse_last_assignment = 3;