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

Interface RateLimitQuotaBucketSettings.ExpiredAssignmentBehaviorOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ExpiredAssignmentBehaviorCase getExpiredAssignmentBehaviorCase()  
      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.
      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.
      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.
      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.
      RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignment getReuseLastAssignment()
      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.
      RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignmentOrBuilder getReuseLastAssignmentOrBuilder()
      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.
      boolean hasExpiredAssignmentBehaviorTimeout()
      Limit the time :ref:`ExpiredAssignmentBehavior <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>` is applied.
      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.
      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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasExpiredAssignmentBehaviorTimeout

        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) = { ... }
        Returns:
        Whether the expiredAssignmentBehaviorTimeout field is set.

      • getExpiredAssignmentBehaviorTimeout

        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) = { ... }
        Returns:
        The expiredAssignmentBehaviorTimeout.

      • getExpiredAssignmentBehaviorTimeoutOrBuilder

        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) = { ... }

      • hasFallbackRateLimit

        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;
        Returns:
        Whether the fallbackRateLimit field is set.

      • getFallbackRateLimit

        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;
        Returns:
        The fallbackRateLimit.

      • getFallbackRateLimitOrBuilder

        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;

      • hasReuseLastAssignment

        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;
        Returns:
        Whether the reuseLastAssignment field is set.

      • getReuseLastAssignment

        RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignment getReuseLastAssignment()
         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;
        Returns:
        The reuseLastAssignment.

      • getReuseLastAssignmentOrBuilder

        RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.ReuseLastAssignmentOrBuilder getReuseLastAssignmentOrBuilder()
         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;