Class LocalRateLimit.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- 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: 13]
Protobuf typeenvoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LocalRateLimit.BuilderaddAllDescriptors(Iterable<? extends LocalRateLimitDescriptor> values)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderaddAllRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuilderaddAllResponseHeadersToAdd(Iterable<? extends HeaderValueOption> values)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimit.BuilderaddDescriptors(int index, LocalRateLimitDescriptor value)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderaddDescriptors(int index, LocalRateLimitDescriptor.Builder builderForValue)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderaddDescriptors(LocalRateLimitDescriptor value)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderaddDescriptors(LocalRateLimitDescriptor.Builder builderForValue)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimitDescriptor.BuilderaddDescriptorsBuilder()The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimitDescriptor.BuilderaddDescriptorsBuilder(int index)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)LocalRateLimit.BuilderaddRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuilderaddRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuilderaddRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuilderaddRequestHeadersToAddWhenNotEnforced(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.HeaderValueOption.BuilderaddRequestHeadersToAddWhenNotEnforcedBuilder()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.HeaderValueOption.BuilderaddRequestHeadersToAddWhenNotEnforcedBuilder(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.LocalRateLimit.BuilderaddResponseHeadersToAdd(int index, HeaderValueOption value)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimit.BuilderaddResponseHeadersToAdd(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.LocalRateLimit.BuilderaddResponseHeadersToAdd(HeaderValueOption value)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimit.BuilderaddResponseHeadersToAdd(HeaderValueOption.Builder builderForValue)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.HeaderValueOption.BuilderaddResponseHeadersToAddBuilder()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.HeaderValueOption.BuilderaddResponseHeadersToAddBuilder(int index)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimitbuild()LocalRateLimitbuildPartial()LocalRateLimit.Builderclear()LocalRateLimit.BuilderclearDescriptors()The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderclearEnableXRatelimitHeaders()Defines the standard version to use for X-RateLimit headers emitted by the filter.LocalRateLimit.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)LocalRateLimit.BuilderclearFilterEnabled()If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.LocalRateLimit.BuilderclearFilterEnforced()If set, this will enforce the rate limit decisions for the given fraction of requests.LocalRateLimit.BuilderclearLocalRateLimitPerDownstreamConnection()Specifies the scope of the rate limiter's token bucket.LocalRateLimit.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)LocalRateLimit.BuilderclearRequestHeadersToAddWhenNotEnforced()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.LocalRateLimit.BuilderclearResponseHeadersToAdd()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimit.BuilderclearStage()Specifies the rate limit configurations to be applied with the same stage number.LocalRateLimit.BuilderclearStatPrefix()The human readable prefix to use when emitting stats.LocalRateLimit.BuilderclearStatus()This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.LocalRateLimit.BuilderclearTokenBucket()The token bucket configuration to use for rate limiting requests that are processed by this filter.LocalRateLimit.Builderclone()LocalRateLimitgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()LocalRateLimitDescriptorgetDescriptors(int index)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimitDescriptor.BuildergetDescriptorsBuilder(int index)The rate limit descriptor list to use in the local rate limit to override on.List<LocalRateLimitDescriptor.Builder>getDescriptorsBuilderList()The rate limit descriptor list to use in the local rate limit to override on.intgetDescriptorsCount()The rate limit descriptor list to use in the local rate limit to override on.List<LocalRateLimitDescriptor>getDescriptorsList()The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimitDescriptorOrBuildergetDescriptorsOrBuilder(int index)The rate limit descriptor list to use in the local rate limit to override on.List<? extends LocalRateLimitDescriptorOrBuilder>getDescriptorsOrBuilderList()The rate limit descriptor list to use in the local rate limit to override on.XRateLimitHeadersRFCVersiongetEnableXRatelimitHeaders()Defines the standard version to use for X-RateLimit headers emitted by the filter.intgetEnableXRatelimitHeadersValue()Defines the standard version to use for X-RateLimit headers emitted by the filter.RuntimeFractionalPercentgetFilterEnabled()If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RuntimeFractionalPercent.BuildergetFilterEnabledBuilder()If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RuntimeFractionalPercentOrBuildergetFilterEnabledOrBuilder()If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RuntimeFractionalPercentgetFilterEnforced()If set, this will enforce the rate limit decisions for the given fraction of requests.RuntimeFractionalPercent.BuildergetFilterEnforcedBuilder()If set, this will enforce the rate limit decisions for the given fraction of requests.RuntimeFractionalPercentOrBuildergetFilterEnforcedOrBuilder()If set, this will enforce the rate limit decisions for the given fraction of requests.booleangetLocalRateLimitPerDownstreamConnection()Specifies the scope of the rate limiter's token bucket.HeaderValueOptiongetRequestHeadersToAddWhenNotEnforced(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.HeaderValueOption.BuildergetRequestHeadersToAddWhenNotEnforcedBuilder(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.List<HeaderValueOption.Builder>getRequestHeadersToAddWhenNotEnforcedBuilderList()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.intgetRequestHeadersToAddWhenNotEnforcedCount()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.List<HeaderValueOption>getRequestHeadersToAddWhenNotEnforcedList()Specifies a list of HTTP headers that should be added to each request that has been rate limited and is also forwarded upstream.HeaderValueOptionOrBuildergetRequestHeadersToAddWhenNotEnforcedOrBuilder(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.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.HeaderValueOptiongetResponseHeadersToAdd(int index)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.HeaderValueOption.BuildergetResponseHeadersToAddBuilder(int index)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.List<HeaderValueOption.Builder>getResponseHeadersToAddBuilderList()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.intgetResponseHeadersToAddCount()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.List<HeaderValueOption>getResponseHeadersToAddList()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.HeaderValueOptionOrBuildergetResponseHeadersToAddOrBuilder(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>getResponseHeadersToAddOrBuilderList()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.StringgetStatPrefix()The human readable prefix to use when emitting stats.com.google.protobuf.ByteStringgetStatPrefixBytes()The human readable prefix to use when emitting stats.HttpStatusgetStatus()This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.HttpStatus.BuildergetStatusBuilder()This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.HttpStatusOrBuildergetStatusOrBuilder()This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.TokenBucketgetTokenBucket()The token bucket configuration to use for rate limiting requests that are processed by this filter.TokenBucket.BuildergetTokenBucketBuilder()The token bucket configuration to use for rate limiting requests that are processed by this filter.TokenBucketOrBuildergetTokenBucketOrBuilder()The token bucket configuration to use for rate limiting requests that are processed by this filter.booleanhasFilterEnabled()If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.booleanhasFilterEnforced()If set, this will enforce the rate limit decisions for the given fraction of requests.booleanhasStatus()This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.booleanhasTokenBucket()The token bucket configuration to use for rate limiting requests that are processed by this filter.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()LocalRateLimit.BuildermergeFilterEnabled(RuntimeFractionalPercent value)If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.LocalRateLimit.BuildermergeFilterEnforced(RuntimeFractionalPercent value)If set, this will enforce the rate limit decisions for the given fraction of requests.LocalRateLimit.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)LocalRateLimit.BuildermergeFrom(com.google.protobuf.Message other)LocalRateLimit.BuildermergeFrom(LocalRateLimit other)LocalRateLimit.BuildermergeStatus(HttpStatus value)This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.LocalRateLimit.BuildermergeTokenBucket(TokenBucket value)The token bucket configuration to use for rate limiting requests that are processed by this filter.LocalRateLimit.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)LocalRateLimit.BuilderremoveDescriptors(int index)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuilderremoveRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuilderremoveResponseHeadersToAdd(int index)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimit.BuildersetDescriptors(int index, LocalRateLimitDescriptor value)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuildersetDescriptors(int index, LocalRateLimitDescriptor.Builder builderForValue)The rate limit descriptor list to use in the local rate limit to override on.LocalRateLimit.BuildersetEnableXRatelimitHeaders(XRateLimitHeadersRFCVersion value)Defines the standard version to use for X-RateLimit headers emitted by the filter.LocalRateLimit.BuildersetEnableXRatelimitHeadersValue(int value)Defines the standard version to use for X-RateLimit headers emitted by the filter.LocalRateLimit.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)LocalRateLimit.BuildersetFilterEnabled(RuntimeFractionalPercent value)If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.LocalRateLimit.BuildersetFilterEnabled(RuntimeFractionalPercent.Builder builderForValue)If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.LocalRateLimit.BuildersetFilterEnforced(RuntimeFractionalPercent value)If set, this will enforce the rate limit decisions for the given fraction of requests.LocalRateLimit.BuildersetFilterEnforced(RuntimeFractionalPercent.Builder builderForValue)If set, this will enforce the rate limit decisions for the given fraction of requests.LocalRateLimit.BuildersetLocalRateLimitPerDownstreamConnection(boolean value)Specifies the scope of the rate limiter's token bucket.LocalRateLimit.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)LocalRateLimit.BuildersetRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuildersetRequestHeadersToAddWhenNotEnforced(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.LocalRateLimit.BuildersetResponseHeadersToAdd(int index, HeaderValueOption value)Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.LocalRateLimit.BuildersetResponseHeadersToAdd(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.LocalRateLimit.BuildersetStage(int value)Specifies the rate limit configurations to be applied with the same stage number.LocalRateLimit.BuildersetStatPrefix(String value)The human readable prefix to use when emitting stats.LocalRateLimit.BuildersetStatPrefixBytes(com.google.protobuf.ByteString value)The human readable prefix to use when emitting stats.LocalRateLimit.BuildersetStatus(HttpStatus value)This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.LocalRateLimit.BuildersetStatus(HttpStatus.Builder builderForValue)This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.LocalRateLimit.BuildersetTokenBucket(TokenBucket value)The token bucket configuration to use for rate limiting requests that are processed by this filter.LocalRateLimit.BuildersetTokenBucket(TokenBucket.Builder builderForValue)The token bucket configuration to use for rate limiting requests that are processed by this filter.LocalRateLimit.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
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
public 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
public LocalRateLimit getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public LocalRateLimit build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public LocalRateLimit buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public LocalRateLimit.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
public LocalRateLimit.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
-
clearOneof
public LocalRateLimit.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- 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
public LocalRateLimit.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<LocalRateLimit.Builder>
-
mergeFrom
public LocalRateLimit.Builder mergeFrom(LocalRateLimit other)
-
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
public String 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
public LocalRateLimit.Builder setStatPrefix(String value)
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
public LocalRateLimit.Builder clearStatPrefix()
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setStatPrefixBytes
public LocalRateLimit.Builder setStatPrefixBytes(com.google.protobuf.ByteString value)
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
public HttpStatus 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
public LocalRateLimit.Builder setStatus(HttpStatus value)
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
public LocalRateLimit.Builder 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. Defaults to 429 (TooManyRequests). .. note:: If this is set to < 400, 429 will be used instead.
.envoy.type.v3.HttpStatus status = 2;
-
mergeStatus
public LocalRateLimit.Builder mergeStatus(HttpStatus value)
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
public LocalRateLimit.Builder 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
public HttpStatus.Builder 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
public HttpStatusOrBuilder 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
public TokenBucket 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
public LocalRateLimit.Builder setTokenBucket(TokenBucket value)
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
public LocalRateLimit.Builder setTokenBucket(TokenBucket.Builder builderForValue)
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
public LocalRateLimit.Builder mergeTokenBucket(TokenBucket value)
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
public LocalRateLimit.Builder 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
public TokenBucket.Builder 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
public TokenBucketOrBuilder 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
public RuntimeFractionalPercent 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
public LocalRateLimit.Builder setFilterEnabled(RuntimeFractionalPercent value)
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
public LocalRateLimit.Builder setFilterEnabled(RuntimeFractionalPercent.Builder builderForValue)
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
public LocalRateLimit.Builder mergeFilterEnabled(RuntimeFractionalPercent value)
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
public LocalRateLimit.Builder 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
public RuntimeFractionalPercent.Builder 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
public RuntimeFractionalPercentOrBuilder 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
public RuntimeFractionalPercent 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
public LocalRateLimit.Builder setFilterEnforced(RuntimeFractionalPercent value)
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
public LocalRateLimit.Builder setFilterEnforced(RuntimeFractionalPercent.Builder builderForValue)
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
public LocalRateLimit.Builder mergeFilterEnforced(RuntimeFractionalPercent value)
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
public LocalRateLimit.Builder 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
public RuntimeFractionalPercent.Builder 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
public RuntimeFractionalPercentOrBuilder 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
public List<HeaderValueOption> 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
public HeaderValueOption 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. 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
public LocalRateLimit.Builder addRequestHeadersToAddWhenNotEnforced(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(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
public LocalRateLimit.Builder 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
public LocalRateLimit.Builder 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. 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
public HeaderValueOption.Builder 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. 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
public HeaderValueOptionOrBuilder getRequestHeadersToAddWhenNotEnforcedOrBuilder(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. 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
public HeaderValueOption.Builder 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
public HeaderValueOption.Builder 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. 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
public List<HeaderValueOption.Builder> 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
public List<HeaderValueOption> 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 either enabled or 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddCountin interfaceLocalRateLimitOrBuilder
-
getResponseHeadersToAdd
public HeaderValueOption getResponseHeadersToAdd(int index)
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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddin interfaceLocalRateLimitOrBuilder
-
setResponseHeadersToAdd
public LocalRateLimit.Builder 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. This occurs when the filter is either enabled or 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
addResponseHeadersToAdd
public LocalRateLimit.Builder addResponseHeadersToAdd(HeaderValueOption value)
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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
addResponseHeadersToAdd
public LocalRateLimit.Builder 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. This occurs when the filter is either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
addResponseHeadersToAdd
public LocalRateLimit.Builder addResponseHeadersToAdd(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 either enabled or 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 either enabled or 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
clearResponseHeadersToAdd
public LocalRateLimit.Builder 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
removeResponseHeadersToAdd
public LocalRateLimit.Builder removeResponseHeadersToAdd(int index)
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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
getResponseHeadersToAddBuilder
public HeaderValueOption.Builder getResponseHeadersToAddBuilder(int index)
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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
getResponseHeadersToAddOrBuilder
public HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(int index)
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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddOrBuilderin interfaceLocalRateLimitOrBuilder
-
getResponseHeadersToAddOrBuilderList
public List<? extends HeaderValueOptionOrBuilder> 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }- Specified by:
getResponseHeadersToAddOrBuilderListin interfaceLocalRateLimitOrBuilder
-
addResponseHeadersToAddBuilder
public HeaderValueOption.Builder 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
addResponseHeadersToAddBuilder
public HeaderValueOption.Builder addResponseHeadersToAddBuilder(int index)
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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
getResponseHeadersToAddBuilderList
public List<HeaderValueOption.Builder> 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 either enabled or fully enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }
-
getDescriptorsList
public List<LocalRateLimitDescriptor> 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
public LocalRateLimitDescriptor getDescriptors(int index)
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
public LocalRateLimit.Builder setDescriptors(int index, LocalRateLimitDescriptor value)
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
public LocalRateLimit.Builder addDescriptors(LocalRateLimitDescriptor value)
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 value)
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(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
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
public LocalRateLimit.Builder 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
public LocalRateLimit.Builder removeDescriptors(int index)
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
public LocalRateLimitDescriptor.Builder getDescriptorsBuilder(int index)
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
public LocalRateLimitDescriptorOrBuilder getDescriptorsOrBuilder(int index)
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
public List<? extends LocalRateLimitDescriptorOrBuilder> 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
public LocalRateLimitDescriptor.Builder 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
public LocalRateLimitDescriptor.Builder addDescriptorsBuilder(int index)
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
public List<LocalRateLimitDescriptor.Builder> 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
public LocalRateLimit.Builder setStage(int value)
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
public LocalRateLimit.Builder 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
public LocalRateLimit.Builder setLocalRateLimitPerDownstreamConnection(boolean value)
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
public LocalRateLimit.Builder 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.
-
getEnableXRatelimitHeadersValue
public int getEnableXRatelimitHeadersValue()
Defines the standard version to use for X-RateLimit headers emitted by the filter. 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
public LocalRateLimit.Builder setEnableXRatelimitHeadersValue(int value)
Defines the standard version to use for X-RateLimit headers emitted by the filter. 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
public XRateLimitHeadersRFCVersion getEnableXRatelimitHeaders()
Defines the standard version to use for X-RateLimit headers emitted by the filter. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Specified by:
getEnableXRatelimitHeadersin interfaceLocalRateLimitOrBuilder- Returns:
- The enableXRatelimitHeaders.
-
setEnableXRatelimitHeaders
public LocalRateLimit.Builder setEnableXRatelimitHeaders(XRateLimitHeadersRFCVersion value)
Defines the standard version to use for X-RateLimit headers emitted by the filter. 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
public LocalRateLimit.Builder clearEnableXRatelimitHeaders()
Defines the standard version to use for X-RateLimit headers emitted by the filter. Disabled by default.
.envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 12 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
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>
-
-