Class RateLimit

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitOrBuilder, java.io.Serializable

    public final class RateLimit
    extends com.google.protobuf.GeneratedMessage
    implements RateLimitOrBuilder
     Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
     Also applies to Local rate limiting :ref:`using descriptors <config_http_filters_local_rate_limit_descriptors>`.
     
    Protobuf type envoy.config.route.v3.RateLimit
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RateLimit.Action
      [#next-free-field: 12]
      static interface  RateLimit.ActionOrBuilder  
      static class  RateLimit.Builder
      Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
      static class  RateLimit.Override
      Protobuf type envoy.config.route.v3.RateLimit.Override
      static interface  RateLimit.OverrideOrBuilder  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private RateLimit()  
      private RateLimit​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      RateLimit.Action getActions​(int index)
      A list of actions that are to be applied for this rate limit configuration.
      int getActionsCount()
      A list of actions that are to be applied for this rate limit configuration.
      java.util.List<RateLimit.Action> getActionsList()
      A list of actions that are to be applied for this rate limit configuration.
      RateLimit.ActionOrBuilder getActionsOrBuilder​(int index)
      A list of actions that are to be applied for this rate limit configuration.
      java.util.List<? extends RateLimit.ActionOrBuilder> getActionsOrBuilderList()
      A list of actions that are to be applied for this rate limit configuration.
      static RateLimit getDefaultInstance()  
      RateLimit getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getDisableKey()
      The key to be set in runtime to disable this rate limit configuration.
      com.google.protobuf.ByteString getDisableKeyBytes()
      The key to be set in runtime to disable this rate limit configuration.
      RateLimit.Override getLimit()
      An optional limit override to be appended to the descriptor produced by this rate limit configuration.
      RateLimit.OverrideOrBuilder getLimitOrBuilder()
      An optional limit override to be appended to the descriptor produced by this rate limit configuration.
      com.google.protobuf.Parser<RateLimit> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UInt32Value getStage()
      Refers to the stage set in the filter.
      com.google.protobuf.UInt32ValueOrBuilder getStageOrBuilder()
      Refers to the stage set in the filter.
      int hashCode()  
      boolean hasLimit()
      An optional limit override to be appended to the descriptor produced by this rate limit configuration.
      boolean hasStage()
      Refers to the stage set in the filter.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static RateLimit.Builder newBuilder()  
      static RateLimit.Builder newBuilder​(RateLimit prototype)  
      RateLimit.Builder newBuilderForType()  
      protected RateLimit.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static RateLimit parseDelimitedFrom​(java.io.InputStream input)  
      static RateLimit parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RateLimit parseFrom​(byte[] data)  
      static RateLimit parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RateLimit parseFrom​(com.google.protobuf.ByteString data)  
      static RateLimit parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RateLimit parseFrom​(com.google.protobuf.CodedInputStream input)  
      static RateLimit parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RateLimit parseFrom​(java.io.InputStream input)  
      static RateLimit parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RateLimit parseFrom​(java.nio.ByteBuffer data)  
      static RateLimit parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<RateLimit> parser()  
      RateLimit.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Field Detail

      • bitField0_

        private int bitField0_
      • stage_

        private com.google.protobuf.UInt32Value stage_
      • DISABLE_KEY_FIELD_NUMBER

        public static final int DISABLE_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • disableKey_

        private volatile java.lang.Object disableKey_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final RateLimit DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<RateLimit> PARSER
    • Constructor Detail

      • RateLimit

        private RateLimit​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • RateLimit

        private RateLimit()
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • hasStage

        public boolean hasStage()
         Refers to the stage set in the filter. The rate limit configuration only
         applies to filters with the same stage number. The default stage number is
         0.
        
         .. note::
        
         The filter supports a range of 0 - 10 inclusively for stage numbers.
         
        .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
        Specified by:
        hasStage in interface RateLimitOrBuilder
        Returns:
        Whether the stage field is set.
      • getStage

        public com.google.protobuf.UInt32Value getStage()
         Refers to the stage set in the filter. The rate limit configuration only
         applies to filters with the same stage number. The default stage number is
         0.
        
         .. note::
        
         The filter supports a range of 0 - 10 inclusively for stage numbers.
         
        .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
        Specified by:
        getStage in interface RateLimitOrBuilder
        Returns:
        The stage.
      • getStageOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getStageOrBuilder()
         Refers to the stage set in the filter. The rate limit configuration only
         applies to filters with the same stage number. The default stage number is
         0.
        
         .. note::
        
         The filter supports a range of 0 - 10 inclusively for stage numbers.
         
        .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
        Specified by:
        getStageOrBuilder in interface RateLimitOrBuilder
      • getDisableKey

        public java.lang.String getDisableKey()
         The key to be set in runtime to disable this rate limit configuration.
         
        string disable_key = 2;
        Specified by:
        getDisableKey in interface RateLimitOrBuilder
        Returns:
        The disableKey.
      • getDisableKeyBytes

        public com.google.protobuf.ByteString getDisableKeyBytes()
         The key to be set in runtime to disable this rate limit configuration.
         
        string disable_key = 2;
        Specified by:
        getDisableKeyBytes in interface RateLimitOrBuilder
        Returns:
        The bytes for disableKey.
      • getActionsList

        public java.util.List<RateLimit.Action> getActionsList()
         A list of actions that are to be applied for this rate limit configuration.
         Order matters as the actions are processed sequentially and the descriptor
         is composed by appending descriptor entries in that sequence. If an action
         cannot append a descriptor entry, no descriptor is generated for the
         configuration. See :ref:`composing actions
         <config_http_filters_rate_limit_composing_actions>` for additional documentation.
         
        repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsList in interface RateLimitOrBuilder
      • getActionsOrBuilderList

        public java.util.List<? extends RateLimit.ActionOrBuilder> getActionsOrBuilderList()
         A list of actions that are to be applied for this rate limit configuration.
         Order matters as the actions are processed sequentially and the descriptor
         is composed by appending descriptor entries in that sequence. If an action
         cannot append a descriptor entry, no descriptor is generated for the
         configuration. See :ref:`composing actions
         <config_http_filters_rate_limit_composing_actions>` for additional documentation.
         
        repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsOrBuilderList in interface RateLimitOrBuilder
      • getActionsCount

        public int getActionsCount()
         A list of actions that are to be applied for this rate limit configuration.
         Order matters as the actions are processed sequentially and the descriptor
         is composed by appending descriptor entries in that sequence. If an action
         cannot append a descriptor entry, no descriptor is generated for the
         configuration. See :ref:`composing actions
         <config_http_filters_rate_limit_composing_actions>` for additional documentation.
         
        repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsCount in interface RateLimitOrBuilder
      • getActions

        public RateLimit.Action getActions​(int index)
         A list of actions that are to be applied for this rate limit configuration.
         Order matters as the actions are processed sequentially and the descriptor
         is composed by appending descriptor entries in that sequence. If an action
         cannot append a descriptor entry, no descriptor is generated for the
         configuration. See :ref:`composing actions
         <config_http_filters_rate_limit_composing_actions>` for additional documentation.
         
        repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActions in interface RateLimitOrBuilder
      • getActionsOrBuilder

        public RateLimit.ActionOrBuilder getActionsOrBuilder​(int index)
         A list of actions that are to be applied for this rate limit configuration.
         Order matters as the actions are processed sequentially and the descriptor
         is composed by appending descriptor entries in that sequence. If an action
         cannot append a descriptor entry, no descriptor is generated for the
         configuration. See :ref:`composing actions
         <config_http_filters_rate_limit_composing_actions>` for additional documentation.
         
        repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsOrBuilder in interface RateLimitOrBuilder
      • hasLimit

        public boolean hasLimit()
         An optional limit override to be appended to the descriptor produced by this
         rate limit configuration. If the override value is invalid or cannot be resolved
         from metadata, no override is provided. See :ref:`rate limit override
         <config_http_filters_rate_limit_rate_limit_override>` for more information.
         
        .envoy.config.route.v3.RateLimit.Override limit = 4;
        Specified by:
        hasLimit in interface RateLimitOrBuilder
        Returns:
        Whether the limit field is set.
      • getLimit

        public RateLimit.Override getLimit()
         An optional limit override to be appended to the descriptor produced by this
         rate limit configuration. If the override value is invalid or cannot be resolved
         from metadata, no override is provided. See :ref:`rate limit override
         <config_http_filters_rate_limit_rate_limit_override>` for more information.
         
        .envoy.config.route.v3.RateLimit.Override limit = 4;
        Specified by:
        getLimit in interface RateLimitOrBuilder
        Returns:
        The limit.
      • getLimitOrBuilder

        public RateLimit.OverrideOrBuilder getLimitOrBuilder()
         An optional limit override to be appended to the descriptor produced by this
         rate limit configuration. If the override value is invalid or cannot be resolved
         from metadata, no override is provided. See :ref:`rate limit override
         <config_http_filters_rate_limit_rate_limit_override>` for more information.
         
        .envoy.config.route.v3.RateLimit.Override limit = 4;
        Specified by:
        getLimitOrBuilder in interface RateLimitOrBuilder
      • isInitialized

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

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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 RateLimit parseFrom​(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RateLimit parseFrom​(java.nio.ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static RateLimit parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RateLimit parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static RateLimit parseFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimit parseFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RateLimit parseDelimitedFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RateLimit parseDelimitedFrom​(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimit parseFrom​(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimit parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public RateLimit.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public RateLimit.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected RateLimit.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static RateLimit getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<RateLimit> parser()
      • getParserForType

        public com.google.protobuf.Parser<RateLimit> 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.GeneratedMessage
      • getDefaultInstanceForType

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