Class LocalRateLimit.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
io.envoyproxy.envoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,LocalRateLimitOrBuilder,Cloneable
- Enclosing class:
- LocalRateLimit
public static final class LocalRateLimit.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
implements LocalRateLimitOrBuilder
[#next-free-field: 19]Protobuf type
envoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit-
Method Summary
Modifier and TypeMethodDescriptionaddAllDescriptors(Iterable<? extends LocalRateLimitDescriptor> values) The rate limit descriptor list to use in the local rate limit to override on.addAllRateLimits(Iterable<? extends RateLimit> values) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.addAllRequestHeadersToAddWhenNotEnforced(Iterable<? extends HeaderValueOption> values) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.addAllResponseHeadersToAdd(Iterable<? extends HeaderValueOption> values) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.addDescriptors(int index, LocalRateLimitDescriptor value) The rate limit descriptor list to use in the local rate limit to override on.addDescriptors(int index, LocalRateLimitDescriptor.Builder builderForValue) The rate limit descriptor list to use in the local rate limit to override on.The rate limit descriptor list to use in the local rate limit to override on.addDescriptors(LocalRateLimitDescriptor.Builder builderForValue) The rate limit descriptor list to use in the local rate limit to override on.The rate limit descriptor list to use in the local rate limit to override on.addDescriptorsBuilder(int index) The rate limit descriptor list to use in the local rate limit to override on.addRateLimits(int index, RateLimit value) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.addRateLimits(int index, RateLimit.Builder builderForValue) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.addRateLimits(RateLimit value) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.addRateLimits(RateLimit.Builder builderForValue) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.Rate limit configuration that is used to generate a list of descriptor entries based on the request context.addRateLimitsBuilder(int index) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption value) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.addRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.addRequestHeadersToAddWhenNotEnforced(HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.addRequestHeadersToAddWhenNotEnforcedBuilder(int index) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.addResponseHeadersToAdd(int index, HeaderValueOption value) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.addResponseHeadersToAdd(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.addResponseHeadersToAdd(HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.addResponseHeadersToAddBuilder(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.build()clear()Specifies if default token bucket should be always consumed.The rate limit descriptor list to use in the local rate limit to override on.Defines the standard version to use for X-RateLimit headers emitted by the filterclearField(com.google.protobuf.Descriptors.FieldDescriptor field) If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.If set, this will enforce the rate limit decisions for the given fraction of requests.Enables the local cluster level rate limiting, iff this is set explicitly.Specifies the scope of the rate limiter's token bucket.Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Specifies whether a ``RESOURCE_EXHAUSTED`` gRPC code must be returned instead of the default ``UNAVAILABLE`` gRPC code for a rate limited gRPC call.Rate limit configuration that is used to generate a list of descriptor entries based on the request context.Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.Specifies the rate limit configurations to be applied with the same stage number.The human readable prefix to use when emitting stats.This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.The token bucket configuration to use for rate limiting requests that are processed by this filter.Specifies if the local rate limit filter should include the virtual host rate limits.clone()com.google.protobuf.BoolValueSpecifies if default token bucket should be always consumed.com.google.protobuf.BoolValue.BuilderSpecifies if default token bucket should be always consumed.com.google.protobuf.BoolValueOrBuilderSpecifies if default token bucket should be always consumed.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetDescriptors(int index) The rate limit descriptor list to use in the local rate limit to override on.getDescriptorsBuilder(int index) The rate limit descriptor list to use in the local rate limit to override on.The rate limit descriptor list to use in the local rate limit to override on.intThe rate limit descriptor list to use in the local rate limit to override on.The rate limit descriptor list to use in the local rate limit to override on.getDescriptorsOrBuilder(int index) The rate limit descriptor list to use in the local rate limit to override on.List<? extends LocalRateLimitDescriptorOrBuilder>The rate limit descriptor list to use in the local rate limit to override on.Defines the standard version to use for X-RateLimit headers emitted by the filterintDefines the standard version to use for X-RateLimit headers emitted by the filterIf set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.If set, this will enforce the rate limit decisions for the given fraction of requests.If set, this will enforce the rate limit decisions for the given fraction of requests.If set, this will enforce the rate limit decisions for the given fraction of requests.Enables the local cluster level rate limiting, iff this is set explicitly.Enables the local cluster level rate limiting, iff this is set explicitly.Enables the local cluster level rate limiting, iff this is set explicitly.booleanSpecifies the scope of the rate limiter's token bucket.com.google.protobuf.UInt32ValueSpecifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.com.google.protobuf.UInt32Value.BuilderSpecifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.com.google.protobuf.UInt32ValueOrBuilderSpecifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.booleanSpecifies whether a ``RESOURCE_EXHAUSTED`` gRPC code must be returned instead of the default ``UNAVAILABLE`` gRPC code for a rate limited gRPC call.getRateLimits(int index) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.getRateLimitsBuilder(int index) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.Rate limit configuration that is used to generate a list of descriptor entries based on the request context.intRate limit configuration that is used to generate a list of descriptor entries based on the request context.Rate limit configuration that is used to generate a list of descriptor entries based on the request context.getRateLimitsOrBuilder(int index) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.List<? extends RateLimitOrBuilder>Rate limit configuration that is used to generate a list of descriptor entries based on the request context.getRequestHeadersToAddWhenNotEnforced(int index) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.getRequestHeadersToAddWhenNotEnforcedBuilder(int index) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.intSpecifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.List<? extends HeaderValueOptionOrBuilder>Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.getResponseHeadersToAdd(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.getResponseHeadersToAddBuilder(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.intSpecifies a list of HTTP headers that should be added to each response for requests that have been rate limited.Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.getResponseHeadersToAddOrBuilder(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.List<? extends HeaderValueOptionOrBuilder>Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.intgetStage()Specifies the rate limit configurations to be applied with the same stage number.The human readable prefix to use when emitting stats.com.google.protobuf.ByteStringThe human readable prefix to use when emitting stats.This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.The token bucket configuration to use for rate limiting requests that are processed by this filter.The token bucket configuration to use for rate limiting requests that are processed by this filter.The token bucket configuration to use for rate limiting requests that are processed by this filter.Specifies if the local rate limit filter should include the virtual host rate limits.intSpecifies if the local rate limit filter should include the virtual host rate limits.booleanSpecifies if default token bucket should be always consumed.booleanIf set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.booleanIf set, this will enforce the rate limit decisions for the given fraction of requests.booleanEnables the local cluster level rate limiting, iff this is set explicitly.booleanSpecifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.booleanThis field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.booleanThe token bucket configuration to use for rate limiting requests that are processed by this filter.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeAlwaysConsumeDefaultTokenBucket(com.google.protobuf.BoolValue value) Specifies if default token bucket should be always consumed.If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.If set, this will enforce the rate limit decisions for the given fraction of requests.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(LocalRateLimit other) Enables the local cluster level rate limiting, iff this is set explicitly.mergeMaxDynamicDescriptors(com.google.protobuf.UInt32Value value) Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.mergeStatus(HttpStatus value) This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.mergeTokenBucket(TokenBucket value) The token bucket configuration to use for rate limiting requests that are processed by this filter.final LocalRateLimit.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removeDescriptors(int index) The rate limit descriptor list to use in the local rate limit to override on.removeRateLimits(int index) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.removeRequestHeadersToAddWhenNotEnforced(int index) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.removeResponseHeadersToAdd(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.setAlwaysConsumeDefaultTokenBucket(com.google.protobuf.BoolValue value) Specifies if default token bucket should be always consumed.setAlwaysConsumeDefaultTokenBucket(com.google.protobuf.BoolValue.Builder builderForValue) Specifies if default token bucket should be always consumed.setDescriptors(int index, LocalRateLimitDescriptor value) The rate limit descriptor list to use in the local rate limit to override on.setDescriptors(int index, LocalRateLimitDescriptor.Builder builderForValue) The rate limit descriptor list to use in the local rate limit to override on.Defines the standard version to use for X-RateLimit headers emitted by the filtersetEnableXRatelimitHeadersValue(int value) Defines the standard version to use for X-RateLimit headers emitted by the filterIf set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.setFilterEnabled(RuntimeFractionalPercent.Builder builderForValue) If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.If set, this will enforce the rate limit decisions for the given fraction of requests.setFilterEnforced(RuntimeFractionalPercent.Builder builderForValue) If set, this will enforce the rate limit decisions for the given fraction of requests.Enables the local cluster level rate limiting, iff this is set explicitly.setLocalClusterRateLimit(LocalClusterRateLimit.Builder builderForValue) Enables the local cluster level rate limiting, iff this is set explicitly.setLocalRateLimitPerDownstreamConnection(boolean value) Specifies the scope of the rate limiter's token bucket.setMaxDynamicDescriptors(com.google.protobuf.UInt32Value value) Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.setMaxDynamicDescriptors(com.google.protobuf.UInt32Value.Builder builderForValue) Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`.setRateLimitedAsResourceExhausted(boolean value) Specifies whether a ``RESOURCE_EXHAUSTED`` gRPC code must be returned instead of the default ``UNAVAILABLE`` gRPC code for a rate limited gRPC call.setRateLimits(int index, RateLimit value) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.setRateLimits(int index, RateLimit.Builder builderForValue) Rate limit configuration that is used to generate a list of descriptor entries based on the request context.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption value) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.setRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.setResponseHeadersToAdd(int index, HeaderValueOption value) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.setResponseHeadersToAdd(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.setStage(int value) Specifies the rate limit configurations to be applied with the same stage number.setStatPrefix(String value) The human readable prefix to use when emitting stats.setStatPrefixBytes(com.google.protobuf.ByteString value) The human readable prefix to use when emitting stats.setStatus(HttpStatus value) This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.setStatus(HttpStatus.Builder builderForValue) This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.setTokenBucket(TokenBucket value) The token bucket configuration to use for rate limiting requests that are processed by this filter.setTokenBucket(TokenBucket.Builder builderForValue) The token bucket configuration to use for rate limiting requests that are processed by this filter.final LocalRateLimit.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Specifies if the local rate limit filter should include the virtual host rate limits.setVhRateLimitsValue(int value) Specifies if the local rate limit filter should include the virtual host rate limits.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
setField
public LocalRateLimit.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
setRepeatedField
public LocalRateLimit.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
addRepeatedField
public LocalRateLimit.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<LocalRateLimit.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
mergeFrom
public LocalRateLimit.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<LocalRateLimit.Builder>- Throws:
IOException
-
getStatPrefix
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }- Specified by:
getStatPrefixin interfaceLocalRateLimitOrBuilder- Returns:
- The statPrefix.
-
getStatPrefixBytes
public com.google.protobuf.ByteString getStatPrefixBytes()The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }- Specified by:
getStatPrefixBytesin interfaceLocalRateLimitOrBuilder- Returns:
- The bytes for statPrefix.
-
setStatPrefix
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }- Parameters:
value- The statPrefix to set.- Returns:
- This builder for chaining.
-
clearStatPrefix
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setStatPrefixBytes
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }- Parameters:
value- The bytes for statPrefix to set.- Returns:
- This builder for chaining.
-
hasStatus
public boolean hasStatus()This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2;- Specified by:
hasStatusin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the status field is set.
-
getStatus
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2;- Specified by:
getStatusin interfaceLocalRateLimitOrBuilder- Returns:
- The status.
-
setStatus
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2; -
setStatus
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2; -
mergeStatus
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2; -
clearStatus
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2; -
getStatusBuilder
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2; -
getStatusOrBuilder
This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2;- Specified by:
getStatusOrBuilderin interfaceLocalRateLimitOrBuilder
-
hasTokenBucket
public boolean hasTokenBucket()The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3;- Specified by:
hasTokenBucketin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the tokenBucket field is set.
-
getTokenBucket
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3;- Specified by:
getTokenBucketin interfaceLocalRateLimitOrBuilder- Returns:
- The tokenBucket.
-
setTokenBucket
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3; -
setTokenBucket
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3; -
mergeTokenBucket
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3; -
clearTokenBucket
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3; -
getTokenBucketBuilder
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3; -
getTokenBucketOrBuilder
The token bucket configuration to use for rate limiting requests that are processed by this filter. Each request processed by the filter consumes a single token. If the token is available, the request will be allowed. If no tokens are available, the request will receive the configured rate limit status. .. note:: It's fine for the token bucket to be unset for the global configuration since the rate limit can be applied at a the virtual host or route level. Thus, the token bucket must be set for the per route configuration otherwise the config will be rejected. .. note:: When using per route configuration, the bucket becomes unique to that route. .. note:: In the current implementation the token bucket's :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive refills.
.envoy.type.v3.TokenBucket token_bucket = 3;- Specified by:
getTokenBucketOrBuilderin interfaceLocalRateLimitOrBuilder
-
hasFilterEnabled
public boolean hasFilterEnabled()If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;- Specified by:
hasFilterEnabledin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the filterEnabled field is set.
-
getFilterEnabled
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;- Specified by:
getFilterEnabledin interfaceLocalRateLimitOrBuilder- Returns:
- The filterEnabled.
-
setFilterEnabled
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4; -
setFilterEnabled
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4; -
mergeFilterEnabled
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4; -
clearFilterEnabled
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4; -
getFilterEnabledBuilder
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4; -
getFilterEnabledOrBuilder
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;- Specified by:
getFilterEnabledOrBuilderin interfaceLocalRateLimitOrBuilder
-
hasFilterEnforced
public boolean hasFilterEnforced()If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;- Specified by:
hasFilterEnforcedin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the filterEnforced field is set.
-
getFilterEnforced
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;- Specified by:
getFilterEnforcedin interfaceLocalRateLimitOrBuilder- Returns:
- The filterEnforced.
-
setFilterEnforced
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5; -
setFilterEnforced
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5; -
mergeFilterEnforced
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5; -
clearFilterEnforced
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5; -
getFilterEnforcedBuilder
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5; -
getFilterEnforcedOrBuilder
If set, this will enforce the rate limit decisions for the given fraction of requests. Note: this only applies to the fraction of enabled requests. Defaults to 0% of requests for safety.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;- Specified by:
getFilterEnforcedOrBuilderin interfaceLocalRateLimitOrBuilder
-
getRequestHeadersToAddWhenNotEnforcedList
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersToAddWhenNotEnforcedListin interfaceLocalRateLimitOrBuilder
-
getRequestHeadersToAddWhenNotEnforcedCount
public int getRequestHeadersToAddWhenNotEnforcedCount()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersToAddWhenNotEnforcedCountin interfaceLocalRateLimitOrBuilder
-
getRequestHeadersToAddWhenNotEnforced
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersToAddWhenNotEnforcedin interfaceLocalRateLimitOrBuilder
-
setRequestHeadersToAddWhenNotEnforced
public LocalRateLimit.Builder setRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption value) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
setRequestHeadersToAddWhenNotEnforced
public LocalRateLimit.Builder setRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
addRequestHeadersToAddWhenNotEnforced
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
addRequestHeadersToAddWhenNotEnforced
public LocalRateLimit.Builder addRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption value) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
addRequestHeadersToAddWhenNotEnforced
public LocalRateLimit.Builder addRequestHeadersToAddWhenNotEnforced(HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
addRequestHeadersToAddWhenNotEnforced
public LocalRateLimit.Builder addRequestHeadersToAddWhenNotEnforced(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
addAllRequestHeadersToAddWhenNotEnforced
public LocalRateLimit.Builder addAllRequestHeadersToAddWhenNotEnforced(Iterable<? extends HeaderValueOption> values) Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
clearRequestHeadersToAddWhenNotEnforced
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
removeRequestHeadersToAddWhenNotEnforced
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
getRequestHeadersToAddWhenNotEnforcedBuilder
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
getRequestHeadersToAddWhenNotEnforcedOrBuilder
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersToAddWhenNotEnforcedOrBuilderin interfaceLocalRateLimitOrBuilder
-
getRequestHeadersToAddWhenNotEnforcedOrBuilderList
public List<? extends HeaderValueOptionOrBuilder> getRequestHeadersToAddWhenNotEnforcedOrBuilderList()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... }- Specified by:
getRequestHeadersToAddWhenNotEnforcedOrBuilderListin interfaceLocalRateLimitOrBuilder
-
addRequestHeadersToAddWhenNotEnforcedBuilder
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
addRequestHeadersToAddWhenNotEnforcedBuilder
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
getRequestHeadersToAddWhenNotEnforcedBuilderList
Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream. This can only occur when the filter is enabled but not enforced.
repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add_when_not_enforced = 10 [(.validate.rules) = { ... } -
getResponseHeadersToAddList
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddListin interfaceLocalRateLimitOrBuilder
-
getResponseHeadersToAddCount
public int getResponseHeadersToAddCount()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddCountin interfaceLocalRateLimitOrBuilder
-
getResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddin interfaceLocalRateLimitOrBuilder
-
setResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
setResponseHeadersToAdd
public LocalRateLimit.Builder setResponseHeadersToAdd(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
addResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
addResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
addResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
addResponseHeadersToAdd
public LocalRateLimit.Builder addResponseHeadersToAdd(int index, HeaderValueOption.Builder builderForValue) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
addAllResponseHeadersToAdd
public LocalRateLimit.Builder addAllResponseHeadersToAdd(Iterable<? extends HeaderValueOption> values) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
clearResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
removeResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
getResponseHeadersToAddBuilder
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
getResponseHeadersToAddOrBuilder
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddOrBuilderin interfaceLocalRateLimitOrBuilder
-
getResponseHeadersToAddOrBuilderList
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddOrBuilderListin interfaceLocalRateLimitOrBuilder
-
addResponseHeadersToAddBuilder
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
addResponseHeadersToAddBuilder
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
getResponseHeadersToAddBuilderList
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. This occurs when the filter is enabled and fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... } -
getDescriptorsList
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8;- Specified by:
getDescriptorsListin interfaceLocalRateLimitOrBuilder
-
getDescriptorsCount
public int getDescriptorsCount()The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8;- Specified by:
getDescriptorsCountin interfaceLocalRateLimitOrBuilder
-
getDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8;- Specified by:
getDescriptorsin interfaceLocalRateLimitOrBuilder
-
setDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
setDescriptors
public LocalRateLimit.Builder setDescriptors(int index, LocalRateLimitDescriptor.Builder builderForValue) The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
addDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
addDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
addDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
addDescriptors
public LocalRateLimit.Builder addDescriptors(int index, LocalRateLimitDescriptor.Builder builderForValue) The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
addAllDescriptors
public LocalRateLimit.Builder addAllDescriptors(Iterable<? extends LocalRateLimitDescriptor> values) The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
clearDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
removeDescriptors
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
getDescriptorsBuilder
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
getDescriptorsOrBuilder
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8;- Specified by:
getDescriptorsOrBuilderin interfaceLocalRateLimitOrBuilder
-
getDescriptorsOrBuilderList
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8;- Specified by:
getDescriptorsOrBuilderListin interfaceLocalRateLimitOrBuilder
-
addDescriptorsBuilder
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
addDescriptorsBuilder
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
getDescriptorsBuilderList
The rate limit descriptor list to use in the local rate limit to override on. The rate limit descriptor is selected by the first full match from the request descriptors. Example on how to use :ref:`this <config_http_filters_local_rate_limit_descriptors>`. .. note:: In the current implementation the descriptor's token bucket :ref:`fill_interval <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be a multiple global :ref:`token bucket's<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.token_bucket>` fill interval. The descriptors must match verbatim for rate limiting to apply. There is no partial match by a subset of descriptor entries in the current implementation.
repeated .envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor descriptors = 8; -
getStage
public int getStage()Specifies the rate limit configurations to be applied with the same stage number. If not set, the default stage number is 0. .. note:: The filter supports a range of 0 - 10 inclusively for stage numbers.
uint32 stage = 9 [(.validate.rules) = { ... }- Specified by:
getStagein interfaceLocalRateLimitOrBuilder- Returns:
- The stage.
-
setStage
Specifies the rate limit configurations to be applied with the same stage number. If not set, the default stage number is 0. .. note:: The filter supports a range of 0 - 10 inclusively for stage numbers.
uint32 stage = 9 [(.validate.rules) = { ... }- Parameters:
value- The stage to set.- Returns:
- This builder for chaining.
-
clearStage
Specifies the rate limit configurations to be applied with the same stage number. If not set, the default stage number is 0. .. note:: The filter supports a range of 0 - 10 inclusively for stage numbers.
uint32 stage = 9 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
getLocalRateLimitPerDownstreamConnection
public boolean getLocalRateLimitPerDownstreamConnection()Specifies the scope of the rate limiter's token bucket. If set to false, the token bucket is shared across all worker threads, thus the rate limits are applied per Envoy process. If set to true, a token bucket is allocated for each connection. Thus the rate limits are applied per connection thereby allowing one to rate limit requests on a per connection basis. If unspecified, the default value is false.
bool local_rate_limit_per_downstream_connection = 11;- Specified by:
getLocalRateLimitPerDownstreamConnectionin interfaceLocalRateLimitOrBuilder- Returns:
- The localRateLimitPerDownstreamConnection.
-
setLocalRateLimitPerDownstreamConnection
Specifies the scope of the rate limiter's token bucket. If set to false, the token bucket is shared across all worker threads, thus the rate limits are applied per Envoy process. If set to true, a token bucket is allocated for each connection. Thus the rate limits are applied per connection thereby allowing one to rate limit requests on a per connection basis. If unspecified, the default value is false.
bool local_rate_limit_per_downstream_connection = 11;- Parameters:
value- The localRateLimitPerDownstreamConnection to set.- Returns:
- This builder for chaining.
-
clearLocalRateLimitPerDownstreamConnection
Specifies the scope of the rate limiter's token bucket. If set to false, the token bucket is shared across all worker threads, thus the rate limits are applied per Envoy process. If set to true, a token bucket is allocated for each connection. Thus the rate limits are applied per connection thereby allowing one to rate limit requests on a per connection basis. If unspecified, the default value is false.
bool local_rate_limit_per_downstream_connection = 11;- Returns:
- This builder for chaining.
-
hasLocalClusterRateLimit
public boolean hasLocalClusterRateLimit()Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16;- Specified by:
hasLocalClusterRateLimitin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the localClusterRateLimit field is set.
-
getLocalClusterRateLimit
Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16;- Specified by:
getLocalClusterRateLimitin interfaceLocalRateLimitOrBuilder- Returns:
- The localClusterRateLimit.
-
setLocalClusterRateLimit
Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16; -
setLocalClusterRateLimit
public LocalRateLimit.Builder setLocalClusterRateLimit(LocalClusterRateLimit.Builder builderForValue) Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16; -
mergeLocalClusterRateLimit
Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16; -
clearLocalClusterRateLimit
Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16; -
getLocalClusterRateLimitBuilder
Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16; -
getLocalClusterRateLimitOrBuilder
Enables the local cluster level rate limiting, iff this is set explicitly. For example, given an Envoy gateway that contains N Envoy instances and a rate limit rule X tokens per second. If this is set, the total rate limit of whole gateway will always be X tokens per second regardless of how N changes. If this is not set, the total rate limit of whole gateway will be N * X tokens per second. .. note:: This should never be set if the ``local_rate_limit_per_downstream_connection`` is set to true. Because if per connection rate limiting is enabled, we assume that the token buckets should never be shared across Envoy instances. .. note:: This only works when the :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` is set and the related cluster is defined in the bootstrap configuration.
.envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit local_cluster_rate_limit = 16;- Specified by:
getLocalClusterRateLimitOrBuilderin interfaceLocalRateLimitOrBuilder
-
getEnableXRatelimitHeadersValue
public int getEnableXRatelimitHeadersValue()Defines the standard version to use for X-RateLimit headers emitted by the filter. * ``X-RateLimit-Limit`` - indicates the request-quota associated to the client in the current time-window followed by the description of the quota policy. * ``X-RateLimit-Remaining`` - indicates the remaining requests in the current time-window. * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of the current time-window. In case rate limiting policy specifies more then one time window, the values above represent the window that is closest to reaching its limit. For more information about the headers specification see selected version of the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Specified by:
getEnableXRatelimitHeadersValuein interfaceLocalRateLimitOrBuilder- Returns:
- The enum numeric value on the wire for enableXRatelimitHeaders.
-
setEnableXRatelimitHeadersValue
Defines the standard version to use for X-RateLimit headers emitted by the filter. * ``X-RateLimit-Limit`` - indicates the request-quota associated to the client in the current time-window followed by the description of the quota policy. * ``X-RateLimit-Remaining`` - indicates the remaining requests in the current time-window. * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of the current time-window. In case rate limiting policy specifies more then one time window, the values above represent the window that is closest to reaching its limit. For more information about the headers specification see selected version of the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Parameters:
value- The enum numeric value on the wire for enableXRatelimitHeaders to set.- Returns:
- This builder for chaining.
-
getEnableXRatelimitHeaders
Defines the standard version to use for X-RateLimit headers emitted by the filter. * ``X-RateLimit-Limit`` - indicates the request-quota associated to the client in the current time-window followed by the description of the quota policy. * ``X-RateLimit-Remaining`` - indicates the remaining requests in the current time-window. * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of the current time-window. In case rate limiting policy specifies more then one time window, the values above represent the window that is closest to reaching its limit. For more information about the headers specification see selected version of the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Specified by:
getEnableXRatelimitHeadersin interfaceLocalRateLimitOrBuilder- Returns:
- The enableXRatelimitHeaders.
-
setEnableXRatelimitHeaders
Defines the standard version to use for X-RateLimit headers emitted by the filter. * ``X-RateLimit-Limit`` - indicates the request-quota associated to the client in the current time-window followed by the description of the quota policy. * ``X-RateLimit-Remaining`` - indicates the remaining requests in the current time-window. * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of the current time-window. In case rate limiting policy specifies more then one time window, the values above represent the window that is closest to reaching its limit. For more information about the headers specification see selected version of the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Parameters:
value- The enableXRatelimitHeaders to set.- Returns:
- This builder for chaining.
-
clearEnableXRatelimitHeaders
Defines the standard version to use for X-RateLimit headers emitted by the filter. * ``X-RateLimit-Limit`` - indicates the request-quota associated to the client in the current time-window followed by the description of the quota policy. * ``X-RateLimit-Remaining`` - indicates the remaining requests in the current time-window. * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of the current time-window. In case rate limiting policy specifies more then one time window, the values above represent the window that is closest to reaching its limit. For more information about the headers specification see selected version of the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
getVhRateLimitsValue
public int getVhRateLimitsValue()Specifies if the local rate limit filter should include the virtual host rate limits.
.envoy.extensions.common.ratelimit.v3.VhRateLimitsOptions vh_rate_limits = 13 [(.validate.rules) = { ... }- Specified by:
getVhRateLimitsValuein interfaceLocalRateLimitOrBuilder- Returns:
- The enum numeric value on the wire for vhRateLimits.
-
setVhRateLimitsValue
Specifies if the local rate limit filter should include the virtual host rate limits.
.envoy.extensions.common.ratelimit.v3.VhRateLimitsOptions vh_rate_limits = 13 [(.validate.rules) = { ... }- Parameters:
value- The enum numeric value on the wire for vhRateLimits to set.- Returns:
- This builder for chaining.
-
getVhRateLimits
Specifies if the local rate limit filter should include the virtual host rate limits.
.envoy.extensions.common.ratelimit.v3.VhRateLimitsOptions vh_rate_limits = 13 [(.validate.rules) = { ... }- Specified by:
getVhRateLimitsin interfaceLocalRateLimitOrBuilder- Returns:
- The vhRateLimits.
-
setVhRateLimits
Specifies if the local rate limit filter should include the virtual host rate limits.
.envoy.extensions.common.ratelimit.v3.VhRateLimitsOptions vh_rate_limits = 13 [(.validate.rules) = { ... }- Parameters:
value- The vhRateLimits to set.- Returns:
- This builder for chaining.
-
clearVhRateLimits
Specifies if the local rate limit filter should include the virtual host rate limits.
.envoy.extensions.common.ratelimit.v3.VhRateLimitsOptions vh_rate_limits = 13 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
hasAlwaysConsumeDefaultTokenBucket
public boolean hasAlwaysConsumeDefaultTokenBucket()Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14;- Specified by:
hasAlwaysConsumeDefaultTokenBucketin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the alwaysConsumeDefaultTokenBucket field is set.
-
getAlwaysConsumeDefaultTokenBucket
public com.google.protobuf.BoolValue getAlwaysConsumeDefaultTokenBucket()Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14;- Specified by:
getAlwaysConsumeDefaultTokenBucketin interfaceLocalRateLimitOrBuilder- Returns:
- The alwaysConsumeDefaultTokenBucket.
-
setAlwaysConsumeDefaultTokenBucket
public LocalRateLimit.Builder setAlwaysConsumeDefaultTokenBucket(com.google.protobuf.BoolValue value) Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14; -
setAlwaysConsumeDefaultTokenBucket
public LocalRateLimit.Builder setAlwaysConsumeDefaultTokenBucket(com.google.protobuf.BoolValue.Builder builderForValue) Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14; -
mergeAlwaysConsumeDefaultTokenBucket
public LocalRateLimit.Builder mergeAlwaysConsumeDefaultTokenBucket(com.google.protobuf.BoolValue value) Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14; -
clearAlwaysConsumeDefaultTokenBucket
Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14; -
getAlwaysConsumeDefaultTokenBucketBuilder
public com.google.protobuf.BoolValue.Builder getAlwaysConsumeDefaultTokenBucketBuilder()Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14; -
getAlwaysConsumeDefaultTokenBucketOrBuilder
public com.google.protobuf.BoolValueOrBuilder getAlwaysConsumeDefaultTokenBucketOrBuilder()Specifies if default token bucket should be always consumed. If set to false, default token bucket will only be consumed when there is no matching descriptor. If set to true, default token bucket will always be consumed. Default is true.
.google.protobuf.BoolValue always_consume_default_token_bucket = 14;- Specified by:
getAlwaysConsumeDefaultTokenBucketOrBuilderin interfaceLocalRateLimitOrBuilder
-
getRateLimitedAsResourceExhausted
public boolean getRateLimitedAsResourceExhausted()Specifies whether a ``RESOURCE_EXHAUSTED`` gRPC code must be returned instead of the default ``UNAVAILABLE`` gRPC code for a rate limited gRPC call. The HTTP code will be 200 for a gRPC response.
bool rate_limited_as_resource_exhausted = 15;- Specified by:
getRateLimitedAsResourceExhaustedin interfaceLocalRateLimitOrBuilder- Returns:
- The rateLimitedAsResourceExhausted.
-
setRateLimitedAsResourceExhausted
Specifies whether a ``RESOURCE_EXHAUSTED`` gRPC code must be returned instead of the default ``UNAVAILABLE`` gRPC code for a rate limited gRPC call. The HTTP code will be 200 for a gRPC response.
bool rate_limited_as_resource_exhausted = 15;- Parameters:
value- The rateLimitedAsResourceExhausted to set.- Returns:
- This builder for chaining.
-
clearRateLimitedAsResourceExhausted
Specifies whether a ``RESOURCE_EXHAUSTED`` gRPC code must be returned instead of the default ``UNAVAILABLE`` gRPC code for a rate limited gRPC call. The HTTP code will be 200 for a gRPC response.
bool rate_limited_as_resource_exhausted = 15;- Returns:
- This builder for chaining.
-
getRateLimitsList
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17;- Specified by:
getRateLimitsListin interfaceLocalRateLimitOrBuilder
-
getRateLimitsCount
public int getRateLimitsCount()Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17;- Specified by:
getRateLimitsCountin interfaceLocalRateLimitOrBuilder
-
getRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17;- Specified by:
getRateLimitsin interfaceLocalRateLimitOrBuilder
-
setRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
setRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
addRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
addRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
addRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
addRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
addAllRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
clearRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
removeRateLimits
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
getRateLimitsBuilder
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
getRateLimitsOrBuilder
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17;- Specified by:
getRateLimitsOrBuilderin interfaceLocalRateLimitOrBuilder
-
getRateLimitsOrBuilderList
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17;- Specified by:
getRateLimitsOrBuilderListin interfaceLocalRateLimitOrBuilder
-
addRateLimitsBuilder
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
addRateLimitsBuilder
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
getRateLimitsBuilderList
Rate limit configuration that is used to generate a list of descriptor entries based on the request context. The generated entries will be used to find one or multiple matched rate limit rule from the ``descriptors``. If this is set, then :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields will be ignored. .. note:: Not all configuration fields of :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here. Following fields are not supported: 1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`. 2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`. 3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`. 4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
repeated .envoy.config.route.v3.RateLimit rate_limits = 17; -
hasMaxDynamicDescriptors
public boolean hasMaxDynamicDescriptors()Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... }- Specified by:
hasMaxDynamicDescriptorsin interfaceLocalRateLimitOrBuilder- Returns:
- Whether the maxDynamicDescriptors field is set.
-
getMaxDynamicDescriptors
public com.google.protobuf.UInt32Value getMaxDynamicDescriptors()Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... }- Specified by:
getMaxDynamicDescriptorsin interfaceLocalRateLimitOrBuilder- Returns:
- The maxDynamicDescriptors.
-
setMaxDynamicDescriptors
Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... } -
setMaxDynamicDescriptors
public LocalRateLimit.Builder setMaxDynamicDescriptors(com.google.protobuf.UInt32Value.Builder builderForValue) Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... } -
mergeMaxDynamicDescriptors
Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... } -
clearMaxDynamicDescriptors
Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... } -
getMaxDynamicDescriptorsBuilder
public com.google.protobuf.UInt32Value.Builder getMaxDynamicDescriptorsBuilder()Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... } -
getMaxDynamicDescriptorsOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getMaxDynamicDescriptorsOrBuilder()Specifies the max dynamic descriptors kept in the cache for a particular wildcard descriptor configured in the global :ref:`descriptors<envoy_v3_api_field_extensions.filters.http.local_ratelimit.v3.LocalRateLimit.descriptors>`. Wildcard descriptor means descriptor has one or more entries with just key and value omitted. For example if user has configured two descriptors with blank value entries, then max dynamic descriptors stored in the LRU cache will be 2 * max_dynamic_descriptors. Actual number of dynamic descriptors will depend on the cardinality of unique values received from the http request for the omitted values. Minimum is 1. Default is 20.
.google.protobuf.UInt32Value max_dynamic_descriptors = 18 [(.validate.rules) = { ... }- Specified by:
getMaxDynamicDescriptorsOrBuilderin interfaceLocalRateLimitOrBuilder
-
setUnknownFields
public final LocalRateLimit.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
mergeUnknownFields
public final LocalRateLimit.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-