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

Class RateLimitConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitConfigOrBuilder, Cloneable
    Enclosing class:
    RateLimitConfig
    public static final class RateLimitConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>
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

    • Method Detail

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

      • clear

        public RateLimitConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public RateLimitConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • setField

        public RateLimitConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • clearField

        public RateLimitConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • clearOneof

        public RateLimitConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • setRepeatedField

        public RateLimitConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • addRepeatedField

        public RateLimitConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • mergeFrom

        public RateLimitConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimitConfig.Builder>

      • isInitialized

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

      • mergeFrom

        public RateLimitConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimitConfig.Builder>
        Throws:
        IOException

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

      • setStage

        public RateLimitConfig.Builder setStage​(int value)
         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) = { ... }
        Parameters:
        value - The stage to set.
        Returns:
        This builder for chaining.

      • clearStage

        public RateLimitConfig.Builder clearStage()
         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) = { ... }
        Returns:
        This builder for chaining.

      • getDisableKey

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

      • setDisableKey

        public RateLimitConfig.Builder setDisableKey​(String value)
         The key to be set in runtime to disable this rate limit configuration.
        string disable_key = 2;
        Parameters:
        value - The disableKey to set.
        Returns:
        This builder for chaining.

      • clearDisableKey

        public RateLimitConfig.Builder clearDisableKey()
         The key to be set in runtime to disable this rate limit configuration.
        string disable_key = 2;
        Returns:
        This builder for chaining.

      • setDisableKeyBytes

        public RateLimitConfig.Builder setDisableKeyBytes​(com.google.protobuf.ByteString value)
         The key to be set in runtime to disable this rate limit configuration.
        string disable_key = 2;
        Parameters:
        value - The bytes for disableKey to set.
        Returns:
        This builder for chaining.

      • getActionsList

        public 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

      • 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

      • setActions

        public RateLimitConfig.Builder setActions​(int index,
                                          RateLimitConfig.Action value)
         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) = { ... }

      • setActions

        public RateLimitConfig.Builder setActions​(int index,
                                          RateLimitConfig.Action.Builder builderForValue)
         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) = { ... }

      • addActions

        public RateLimitConfig.Builder addActions​(RateLimitConfig.Action value)
         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) = { ... }

      • addActions

        public RateLimitConfig.Builder addActions​(int index,
                                          RateLimitConfig.Action value)
         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) = { ... }

      • addActions

        public RateLimitConfig.Builder addActions​(RateLimitConfig.Action.Builder builderForValue)
         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) = { ... }

      • addActions

        public RateLimitConfig.Builder addActions​(int index,
                                          RateLimitConfig.Action.Builder builderForValue)
         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) = { ... }

      • addAllActions

        public RateLimitConfig.Builder addAllActions​(Iterable<? extends RateLimitConfig.Action> values)
         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) = { ... }

      • clearActions

        public RateLimitConfig.Builder clearActions()
         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) = { ... }

      • removeActions

        public RateLimitConfig.Builder removeActions​(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) = { ... }

      • getActionsBuilder

        public RateLimitConfig.Action.Builder getActionsBuilder​(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) = { ... }

      • 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

      • getActionsOrBuilderList

        public 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

      • addActionsBuilder

        public RateLimitConfig.Action.Builder addActionsBuilder()
         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) = { ... }

      • addActionsBuilder

        public RateLimitConfig.Action.Builder addActionsBuilder​(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) = { ... }

      • getActionsBuilderList

        public List<RateLimitConfig.Action.Builder> getActionsBuilderList()
         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) = { ... }

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

      • setLimit

        public RateLimitConfig.Builder setLimit​(RateLimitConfig.Override value)
         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;

      • setLimit

        public RateLimitConfig.Builder setLimit​(RateLimitConfig.Override.Builder builderForValue)
         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;

      • mergeLimit

        public RateLimitConfig.Builder mergeLimit​(RateLimitConfig.Override value)
         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;

      • clearLimit

        public RateLimitConfig.Builder clearLimit()
         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;

      • getLimitBuilder

        public RateLimitConfig.Override.Builder getLimitBuilder()
         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;

      • 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

      • setUnknownFields

        public final RateLimitConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>

      • mergeUnknownFields

        public final RateLimitConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitConfig.Builder>