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

Class RateLimit.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitOrBuilder, Cloneable
    Enclosing class:
    RateLimit
    public static final class RateLimit.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>
implements RateLimitOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.extensions.filters.network.ratelimit.v3.RateLimit

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public RateLimit.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<RateLimit.Builder>
        Throws:
        IOException

      • getStatPrefix

        public String getStatPrefix()
         The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefix in interface RateLimitOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        public com.google.protobuf.ByteString getStatPrefixBytes()
         The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefixBytes in interface RateLimitOrBuilder
        Returns:
        The bytes for statPrefix.

      • setStatPrefix

        public RateLimit.Builder setStatPrefix​(String value)
         The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The statPrefix to set.
        Returns:
        This builder for chaining.

      • clearStatPrefix

        public RateLimit.Builder clearStatPrefix()
         The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setStatPrefixBytes

        public RateLimit.Builder setStatPrefixBytes​(com.google.protobuf.ByteString value)
         The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for statPrefix to set.
        Returns:
        This builder for chaining.

      • getDomain

        public String getDomain()
         The rate limit domain to use in the rate limit service request.
        string domain = 2 [(.validate.rules) = { ... }
        Specified by:
        getDomain in interface RateLimitOrBuilder
        Returns:
        The domain.

      • getDomainBytes

        public com.google.protobuf.ByteString getDomainBytes()
         The rate limit domain to use in the rate limit service request.
        string domain = 2 [(.validate.rules) = { ... }
        Specified by:
        getDomainBytes in interface RateLimitOrBuilder
        Returns:
        The bytes for domain.

      • setDomain

        public RateLimit.Builder setDomain​(String value)
         The rate limit domain to use in the rate limit service request.
        string domain = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The domain to set.
        Returns:
        This builder for chaining.

      • clearDomain

        public RateLimit.Builder clearDomain()
         The rate limit domain to use in the rate limit service request.
        string domain = 2 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setDomainBytes

        public RateLimit.Builder setDomainBytes​(com.google.protobuf.ByteString value)
         The rate limit domain to use in the rate limit service request.
        string domain = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for domain to set.
        Returns:
        This builder for chaining.

      • getDescriptorsList

        public List<RateLimitDescriptor> getDescriptorsList()
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorsList in interface RateLimitOrBuilder

      • getDescriptorsCount

        public int getDescriptorsCount()
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorsCount in interface RateLimitOrBuilder

      • getDescriptors

        public RateLimitDescriptor getDescriptors​(int index)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }
        Specified by:
        getDescriptors in interface RateLimitOrBuilder

      • setDescriptors

        public RateLimit.Builder setDescriptors​(int index,
                                        RateLimitDescriptor value)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • setDescriptors

        public RateLimit.Builder setDescriptors​(int index,
                                        RateLimitDescriptor.Builder builderForValue)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • addDescriptors

        public RateLimit.Builder addDescriptors​(RateLimitDescriptor value)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • addDescriptors

        public RateLimit.Builder addDescriptors​(int index,
                                        RateLimitDescriptor value)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • addDescriptors

        public RateLimit.Builder addDescriptors​(RateLimitDescriptor.Builder builderForValue)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • addDescriptors

        public RateLimit.Builder addDescriptors​(int index,
                                        RateLimitDescriptor.Builder builderForValue)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • addAllDescriptors

        public RateLimit.Builder addAllDescriptors​(Iterable<? extends RateLimitDescriptor> values)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • clearDescriptors

        public RateLimit.Builder clearDescriptors()
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • removeDescriptors

        public RateLimit.Builder removeDescriptors​(int index)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • getDescriptorsBuilder

        public RateLimitDescriptor.Builder getDescriptorsBuilder​(int index)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • getDescriptorsOrBuilder

        public RateLimitDescriptorOrBuilder getDescriptorsOrBuilder​(int index)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorsOrBuilder in interface RateLimitOrBuilder

      • addDescriptorsBuilder

        public RateLimitDescriptor.Builder addDescriptorsBuilder()
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • addDescriptorsBuilder

        public RateLimitDescriptor.Builder addDescriptorsBuilder​(int index)
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • getDescriptorsBuilderList

        public List<RateLimitDescriptor.Builder> getDescriptorsBuilderList()
         The rate limit descriptor list to use in the rate limit service request.
        repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

      • hasTimeout

        public boolean hasTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;
        Specified by:
        hasTimeout in interface RateLimitOrBuilder
        Returns:
        Whether the timeout field is set.

      • getTimeout

        public com.google.protobuf.Duration getTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;
        Specified by:
        getTimeout in interface RateLimitOrBuilder
        Returns:
        The timeout.

      • setTimeout

        public RateLimit.Builder setTimeout​(com.google.protobuf.Duration value)
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • setTimeout

        public RateLimit.Builder setTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • mergeTimeout

        public RateLimit.Builder mergeTimeout​(com.google.protobuf.Duration value)
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • clearTimeout

        public RateLimit.Builder clearTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • getTimeoutBuilder

        public com.google.protobuf.Duration.Builder getTimeoutBuilder()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • getTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;
        Specified by:
        getTimeoutOrBuilder in interface RateLimitOrBuilder

      • getFailureModeDeny

        public boolean getFailureModeDeny()
         The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
        bool failure_mode_deny = 5;
        Specified by:
        getFailureModeDeny in interface RateLimitOrBuilder
        Returns:
        The failureModeDeny.

      • setFailureModeDeny

        public RateLimit.Builder setFailureModeDeny​(boolean value)
         The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
        bool failure_mode_deny = 5;
        Parameters:
        value - The failureModeDeny to set.
        Returns:
        This builder for chaining.

      • clearFailureModeDeny

        public RateLimit.Builder clearFailureModeDeny()
         The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
        bool failure_mode_deny = 5;
        Returns:
        This builder for chaining.

      • hasRateLimitService

        public boolean hasRateLimitService()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }
        Specified by:
        hasRateLimitService in interface RateLimitOrBuilder
        Returns:
        Whether the rateLimitService field is set.

      • getRateLimitService

        public RateLimitServiceConfig getRateLimitService()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }
        Specified by:
        getRateLimitService in interface RateLimitOrBuilder
        Returns:
        The rateLimitService.

      • setRateLimitService

        public RateLimit.Builder setRateLimitService​(RateLimitServiceConfig value)
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }

      • setRateLimitService

        public RateLimit.Builder setRateLimitService​(RateLimitServiceConfig.Builder builderForValue)
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }

      • mergeRateLimitService

        public RateLimit.Builder mergeRateLimitService​(RateLimitServiceConfig value)
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }

      • clearRateLimitService

        public RateLimit.Builder clearRateLimitService()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }

      • getRateLimitServiceBuilder

        public RateLimitServiceConfig.Builder getRateLimitServiceBuilder()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }

      • getRateLimitServiceOrBuilder

        public RateLimitServiceConfigOrBuilder getRateLimitServiceOrBuilder()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }
        Specified by:
        getRateLimitServiceOrBuilder in interface RateLimitOrBuilder

      • setUnknownFields

        public final RateLimit.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<RateLimit.Builder>

      • mergeUnknownFields

        public final RateLimit.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<RateLimit.Builder>