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

Class RateLimitQuotaResponse.BucketAction

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaResponse.BucketActionOrBuilder, Serializable
    Enclosing class:
    RateLimitQuotaResponse
    public static final class RateLimitQuotaResponse.BucketAction
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitQuotaResponse.BucketActionOrBuilder
     Commands the data plane to apply one of the actions to the bucket with the
 :ref:`bucket_id <envoy_v3_api_field_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.bucket_id>`.
    Protobuf type envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction
    See Also:
    Serialized Form

    • Field Detail

      • QUOTA_ASSIGNMENT_ACTION_FIELD_NUMBER

        public static final int QUOTA_ASSIGNMENT_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ABANDON_ACTION_FIELD_NUMBER

        public static final int ABANDON_ACTION_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

      • hasBucketId

        public boolean hasBucketId()
         ``BucketId`` for which request the action is applied.
        .envoy.service.rate_limit_quota.v3.BucketId bucket_id = 1 [(.validate.rules) = { ... }
        Specified by:
        hasBucketId in interface RateLimitQuotaResponse.BucketActionOrBuilder
        Returns:
        Whether the bucketId field is set.

      • hasQuotaAssignmentAction

        public boolean hasQuotaAssignmentAction()
         Apply the quota assignment to the bucket.
 Commands the data plane to apply a rate limiting strategy to the bucket.
 The process of applying and expiring the rate limiting strategy is detailed in the
 :ref:`QuotaAssignmentAction
 <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`
 message.
        .envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction quota_assignment_action = 2;
        Specified by:
        hasQuotaAssignmentAction in interface RateLimitQuotaResponse.BucketActionOrBuilder
        Returns:
        Whether the quotaAssignmentAction field is set.

      • getQuotaAssignmentAction

        public RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction getQuotaAssignmentAction()
         Apply the quota assignment to the bucket.
 Commands the data plane to apply a rate limiting strategy to the bucket.
 The process of applying and expiring the rate limiting strategy is detailed in the
 :ref:`QuotaAssignmentAction
 <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`
 message.
        .envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction quota_assignment_action = 2;
        Specified by:
        getQuotaAssignmentAction in interface RateLimitQuotaResponse.BucketActionOrBuilder
        Returns:
        The quotaAssignmentAction.

      • getQuotaAssignmentActionOrBuilder

        public RateLimitQuotaResponse.BucketAction.QuotaAssignmentActionOrBuilder getQuotaAssignmentActionOrBuilder()
         Apply the quota assignment to the bucket.
 Commands the data plane to apply a rate limiting strategy to the bucket.
 The process of applying and expiring the rate limiting strategy is detailed in the
 :ref:`QuotaAssignmentAction
 <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`
 message.
        .envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction quota_assignment_action = 2;
        Specified by:
        getQuotaAssignmentActionOrBuilder in interface RateLimitQuotaResponse.BucketActionOrBuilder

      • hasAbandonAction

        public boolean hasAbandonAction()
         Abandon the bucket.
 Commands the data plane to abandon the bucket.
 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.
        .envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction abandon_action = 3;
        Specified by:
        hasAbandonAction in interface RateLimitQuotaResponse.BucketActionOrBuilder
        Returns:
        Whether the abandonAction field is set.

      • getAbandonAction

        public RateLimitQuotaResponse.BucketAction.AbandonAction getAbandonAction()
         Abandon the bucket.
 Commands the data plane to abandon the bucket.
 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.
        .envoy.service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction abandon_action = 3;
        Specified by:
        getAbandonAction in interface RateLimitQuotaResponse.BucketActionOrBuilder
        Returns:
        The abandonAction.

      • 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 RateLimitQuotaResponse.BucketAction parseFrom​(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static RateLimitQuotaResponse.BucketAction 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 parseFrom​(byte[] data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

        public RateLimitQuotaResponse.BucketAction.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RateLimitQuotaResponse.BucketAction.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<RateLimitQuotaResponse.BucketAction> 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 RateLimitQuotaResponse.BucketAction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder