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

Class RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior

    • Field Detail

      • EXPIRED_ASSIGNMENT_BEHAVIOR_TIMEOUT_FIELD_NUMBER

        public static final int EXPIRED_ASSIGNMENT_BEHAVIOR_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FALLBACK_RATE_LIMIT_FIELD_NUMBER

        public static final int FALLBACK_RATE_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REUSE_LAST_ASSIGNMENT_FIELD_NUMBER

        public static final int REUSE_LAST_ASSIGNMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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.

      • 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.

      • 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.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • equals

        public boolean equals​(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 RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior parseFrom​(com.google.protobuf.ByteString data,
                                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior parseFrom​(byte[] data,
                                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • getParserForType

        public com.google.protobuf.Parser<RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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