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

Class RateLimitConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitConfigOrBuilder, java.io.Serializable
    public final class RateLimitConfig
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitConfigOrBuilder
     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>`.
 [#not-implemented-hide:]
    Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RateLimitConfig.Action
      [#next-free-field: 10]
      static interface  RateLimitConfig.ActionOrBuilder  
      static class  RateLimitConfig.Builder
      Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
      static class  RateLimitConfig.Override
      Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override
      static interface  RateLimitConfig.OverrideOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTIONS_FIELD_NUMBER  
      static int DISABLE_KEY_FIELD_NUMBER  
      static int LIMIT_FIELD_NUMBER  
      static int STAGE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected java.lang.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

      • getStage

        public int 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.
        uint32 stage = 1 [(.validate.rules) = { ... }
        Specified by:
        getStage in interface RateLimitConfigOrBuilder
        Returns:
        The stage.

      • 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 RateLimitConfigOrBuilder
        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 RateLimitConfigOrBuilder
        Returns:
        The bytes for disableKey.

      • getActionsList

        public java.util.List<RateLimitConfig.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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsList in interface RateLimitConfigOrBuilder

      • getActionsOrBuilderList

        public java.util.List<? extends RateLimitConfig.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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsOrBuilderList in interface RateLimitConfigOrBuilder

      • 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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsCount in interface RateLimitConfigOrBuilder

      • getActions

        public RateLimitConfig.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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActions in interface RateLimitConfigOrBuilder

      • getActionsOrBuilder

        public RateLimitConfig.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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }
        Specified by:
        getActionsOrBuilder in interface RateLimitConfigOrBuilder

      • 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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override limit = 4;
        Specified by:
        hasLimit in interface RateLimitConfigOrBuilder
        Returns:
        Whether the limit field is set.

      • getLimit

        public RateLimitConfig.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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override limit = 4;
        Specified by:
        getLimit in interface RateLimitConfigOrBuilder
        Returns:
        The limit.

      • getLimitOrBuilder

        public RateLimitConfig.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.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override limit = 4;
        Specified by:
        getLimitOrBuilder in interface RateLimitConfigOrBuilder

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(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 RateLimitConfig parseFrom​(java.nio.ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

        public static com.google.protobuf.Parser<RateLimitConfig> parser()

      • getParserForType

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