Class RateLimitQuotaFilterConfig.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaFilterConfig.Builder>
-
- io.envoyproxy.envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaFilterConfig.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimitQuotaFilterConfigOrBuilder
,java.lang.Cloneable
- Enclosing class:
- RateLimitQuotaFilterConfig
public static final class RateLimitQuotaFilterConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaFilterConfig.Builder> implements RateLimitQuotaFilterConfigOrBuilder
Configures the Rate Limit Quota filter. Can be overridden in the per-route and per-host configurations. The more specific definition completely overrides the less specific definition. [#next-free-field: 7]
Protobuf typeenvoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaFilterConfig
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RateLimitQuotaFilterConfig.Builder
addAllRequestHeadersToAddWhenNotEnforced(java.lang.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.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.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.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.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.RateLimitQuotaFilterConfig
build()
RateLimitQuotaFilterConfig
buildPartial()
private void
buildPartial0(RateLimitQuotaFilterConfig result)
private void
buildPartialRepeatedFields(RateLimitQuotaFilterConfig result)
RateLimitQuotaFilterConfig.Builder
clear()
RateLimitQuotaFilterConfig.Builder
clearBucketMatchers()
The match tree to use for grouping incoming requests into buckets.RateLimitQuotaFilterConfig.Builder
clearDomain()
The application domain to use when calling the service.RateLimitQuotaFilterConfig.Builder
clearFilterEnabled()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RateLimitQuotaFilterConfig.Builder
clearFilterEnforced()
If set, this will enforce the rate limit decisions for the given fraction of requests.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.Builder
clearRlqsServer()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.private void
ensureRequestHeadersToAddWhenNotEnforcedIsMutable()
Matcher
getBucketMatchers()
The match tree to use for grouping incoming requests into buckets.Matcher.Builder
getBucketMatchersBuilder()
The match tree to use for grouping incoming requests into buckets.private com.google.protobuf.SingleFieldBuilder<Matcher,Matcher.Builder,MatcherOrBuilder>
getBucketMatchersFieldBuilder()
The match tree to use for grouping incoming requests into buckets.MatcherOrBuilder
getBucketMatchersOrBuilder()
The match tree to use for grouping incoming requests into buckets.RateLimitQuotaFilterConfig
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.String
getDomain()
The application domain to use when calling the service.com.google.protobuf.ByteString
getDomainBytes()
The application domain to use when calling the service.RuntimeFractionalPercent
getFilterEnabled()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RuntimeFractionalPercent.Builder
getFilterEnabledBuilder()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,RuntimeFractionalPercent.Builder,RuntimeFractionalPercentOrBuilder>
getFilterEnabledFieldBuilder()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RuntimeFractionalPercentOrBuilder
getFilterEnabledOrBuilder()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RuntimeFractionalPercent
getFilterEnforced()
If set, this will enforce the rate limit decisions for the given fraction of requests.RuntimeFractionalPercent.Builder
getFilterEnforcedBuilder()
If set, this will enforce the rate limit decisions for the given fraction of requests.private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,RuntimeFractionalPercent.Builder,RuntimeFractionalPercentOrBuilder>
getFilterEnforcedFieldBuilder()
If set, this will enforce the rate limit decisions for the given fraction of requests.RuntimeFractionalPercentOrBuilder
getFilterEnforcedOrBuilder()
If set, this will enforce the rate limit decisions for the given fraction of requests.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.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.java.util.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.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.private com.google.protobuf.RepeatedFieldBuilder<HeaderValueOption,HeaderValueOption.Builder,HeaderValueOptionOrBuilder>
getRequestHeadersToAddWhenNotEnforcedFieldBuilder()
java.util.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.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.java.util.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.GrpcService
getRlqsServer()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.GrpcService.Builder
getRlqsServerBuilder()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.private com.google.protobuf.SingleFieldBuilder<GrpcService,GrpcService.Builder,GrpcServiceOrBuilder>
getRlqsServerFieldBuilder()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.GrpcServiceOrBuilder
getRlqsServerOrBuilder()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.boolean
hasBucketMatchers()
The match tree to use for grouping incoming requests into buckets.boolean
hasFilterEnabled()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.boolean
hasFilterEnforced()
If set, this will enforce the rate limit decisions for the given fraction of requests.boolean
hasRlqsServer()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
private void
maybeForceBuilderInitialization()
RateLimitQuotaFilterConfig.Builder
mergeBucketMatchers(Matcher value)
The match tree to use for grouping incoming requests into buckets.RateLimitQuotaFilterConfig.Builder
mergeFilterEnabled(RuntimeFractionalPercent value)
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RateLimitQuotaFilterConfig.Builder
mergeFilterEnforced(RuntimeFractionalPercent value)
If set, this will enforce the rate limit decisions for the given fraction of requests.RateLimitQuotaFilterConfig.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RateLimitQuotaFilterConfig.Builder
mergeFrom(com.google.protobuf.Message other)
RateLimitQuotaFilterConfig.Builder
mergeFrom(RateLimitQuotaFilterConfig other)
RateLimitQuotaFilterConfig.Builder
mergeRlqsServer(GrpcService value)
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.Builder
setBucketMatchers(Matcher value)
The match tree to use for grouping incoming requests into buckets.RateLimitQuotaFilterConfig.Builder
setBucketMatchers(Matcher.Builder builderForValue)
The match tree to use for grouping incoming requests into buckets.RateLimitQuotaFilterConfig.Builder
setDomain(java.lang.String value)
The application domain to use when calling the service.RateLimitQuotaFilterConfig.Builder
setDomainBytes(com.google.protobuf.ByteString value)
The application domain to use when calling the service.RateLimitQuotaFilterConfig.Builder
setFilterEnabled(RuntimeFractionalPercent value)
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RateLimitQuotaFilterConfig.Builder
setFilterEnabled(RuntimeFractionalPercent.Builder builderForValue)
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.RateLimitQuotaFilterConfig.Builder
setFilterEnforced(RuntimeFractionalPercent value)
If set, this will enforce the rate limit decisions for the given fraction of requests.RateLimitQuotaFilterConfig.Builder
setFilterEnforced(RuntimeFractionalPercent.Builder builderForValue)
If set, this will enforce the rate limit decisions for the given fraction of requests.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.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.RateLimitQuotaFilterConfig.Builder
setRlqsServer(GrpcService value)
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.RateLimitQuotaFilterConfig.Builder
setRlqsServer(GrpcService.Builder builderForValue)
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, 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
-
-
-
-
Field Detail
-
bitField0_
private int bitField0_
-
rlqsServer_
private GrpcService rlqsServer_
-
rlqsServerBuilder_
private com.google.protobuf.SingleFieldBuilder<GrpcService,GrpcService.Builder,GrpcServiceOrBuilder> rlqsServerBuilder_
-
domain_
private java.lang.Object domain_
-
bucketMatchers_
private Matcher bucketMatchers_
-
bucketMatchersBuilder_
private com.google.protobuf.SingleFieldBuilder<Matcher,Matcher.Builder,MatcherOrBuilder> bucketMatchersBuilder_
-
filterEnabled_
private RuntimeFractionalPercent filterEnabled_
-
filterEnabledBuilder_
private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,RuntimeFractionalPercent.Builder,RuntimeFractionalPercentOrBuilder> filterEnabledBuilder_
-
filterEnforced_
private RuntimeFractionalPercent filterEnforced_
-
filterEnforcedBuilder_
private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,RuntimeFractionalPercent.Builder,RuntimeFractionalPercentOrBuilder> filterEnforcedBuilder_
-
requestHeadersToAddWhenNotEnforced_
private java.util.List<HeaderValueOption> requestHeadersToAddWhenNotEnforced_
-
requestHeadersToAddWhenNotEnforcedBuilder_
private com.google.protobuf.RepeatedFieldBuilder<HeaderValueOption,HeaderValueOption.Builder,HeaderValueOptionOrBuilder> requestHeadersToAddWhenNotEnforcedBuilder_
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaFilterConfig.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization()
-
clear
public RateLimitQuotaFilterConfig.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaFilterConfig.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaFilterConfig.Builder>
-
getDefaultInstanceForType
public RateLimitQuotaFilterConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public RateLimitQuotaFilterConfig build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public RateLimitQuotaFilterConfig buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartialRepeatedFields
private void buildPartialRepeatedFields(RateLimitQuotaFilterConfig result)
-
buildPartial0
private void buildPartial0(RateLimitQuotaFilterConfig result)
-
mergeFrom
public RateLimitQuotaFilterConfig.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RateLimitQuotaFilterConfig.Builder>
-
mergeFrom
public RateLimitQuotaFilterConfig.Builder mergeFrom(RateLimitQuotaFilterConfig other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaFilterConfig.Builder>
-
mergeFrom
public RateLimitQuotaFilterConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RateLimitQuotaFilterConfig.Builder>
- Throws:
java.io.IOException
-
hasRlqsServer
public boolean hasRlqsServer()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
- Specified by:
hasRlqsServer
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- Whether the rlqsServer field is set.
-
getRlqsServer
public GrpcService getRlqsServer()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
- Specified by:
getRlqsServer
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- The rlqsServer.
-
setRlqsServer
public RateLimitQuotaFilterConfig.Builder setRlqsServer(GrpcService value)
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
-
setRlqsServer
public RateLimitQuotaFilterConfig.Builder setRlqsServer(GrpcService.Builder builderForValue)
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
-
mergeRlqsServer
public RateLimitQuotaFilterConfig.Builder mergeRlqsServer(GrpcService value)
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
-
clearRlqsServer
public RateLimitQuotaFilterConfig.Builder clearRlqsServer()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
-
getRlqsServerBuilder
public GrpcService.Builder getRlqsServerBuilder()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
-
getRlqsServerOrBuilder
public GrpcServiceOrBuilder getRlqsServerOrBuilder()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
- Specified by:
getRlqsServerOrBuilder
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
getRlqsServerFieldBuilder
private com.google.protobuf.SingleFieldBuilder<GrpcService,GrpcService.Builder,GrpcServiceOrBuilder> getRlqsServerFieldBuilder()
Configures the gRPC Rate Limit Quota Service (RLQS) RateLimitQuotaService.
.envoy.config.core.v3.GrpcService rlqs_server = 1 [(.validate.rules) = { ... }
-
getDomain
public java.lang.String getDomain()
The application domain to use when calling the service. This enables sharing the quota server between different applications without fear of overlap. E.g., "envoy".
string domain = 2 [(.validate.rules) = { ... }
- Specified by:
getDomain
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- The domain.
-
getDomainBytes
public com.google.protobuf.ByteString getDomainBytes()
The application domain to use when calling the service. This enables sharing the quota server between different applications without fear of overlap. E.g., "envoy".
string domain = 2 [(.validate.rules) = { ... }
- Specified by:
getDomainBytes
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- The bytes for domain.
-
setDomain
public RateLimitQuotaFilterConfig.Builder setDomain(java.lang.String value)
The application domain to use when calling the service. This enables sharing the quota server between different applications without fear of overlap. E.g., "envoy".
string domain = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The domain to set.- Returns:
- This builder for chaining.
-
clearDomain
public RateLimitQuotaFilterConfig.Builder clearDomain()
The application domain to use when calling the service. This enables sharing the quota server between different applications without fear of overlap. E.g., "envoy".
string domain = 2 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setDomainBytes
public RateLimitQuotaFilterConfig.Builder setDomainBytes(com.google.protobuf.ByteString value)
The application domain to use when calling the service. This enables sharing the quota server between different applications without fear of overlap. E.g., "envoy".
string domain = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for domain to set.- Returns:
- This builder for chaining.
-
hasBucketMatchers
public boolean hasBucketMatchers()
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
- Specified by:
hasBucketMatchers
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- Whether the bucketMatchers field is set.
-
getBucketMatchers
public Matcher getBucketMatchers()
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
- Specified by:
getBucketMatchers
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- The bucketMatchers.
-
setBucketMatchers
public RateLimitQuotaFilterConfig.Builder setBucketMatchers(Matcher value)
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
-
setBucketMatchers
public RateLimitQuotaFilterConfig.Builder setBucketMatchers(Matcher.Builder builderForValue)
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
-
mergeBucketMatchers
public RateLimitQuotaFilterConfig.Builder mergeBucketMatchers(Matcher value)
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
-
clearBucketMatchers
public RateLimitQuotaFilterConfig.Builder clearBucketMatchers()
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
-
getBucketMatchersBuilder
public Matcher.Builder getBucketMatchersBuilder()
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
-
getBucketMatchersOrBuilder
public MatcherOrBuilder getBucketMatchersOrBuilder()
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
- Specified by:
getBucketMatchersOrBuilder
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
getBucketMatchersFieldBuilder
private com.google.protobuf.SingleFieldBuilder<Matcher,Matcher.Builder,MatcherOrBuilder> getBucketMatchersFieldBuilder()
The match tree to use for grouping incoming requests into buckets. Example: .. validated-code-block:: yaml :type-name: xds.type.matcher.v3.Matcher matcher_list: matchers: # Assign requests with header['env'] set to 'staging' to the bucket { name: 'staging' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput header_name: env value_match: exact: staging on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: name: string_value: staging # Assign requests with header['user_group'] set to 'admin' to the bucket { acl: 'admin_users' } - predicate: single_predicate: input: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.HttpAttributesCelMatchInput custom_match: typed_config: '@type': type.googleapis.com/xds.type.matcher.v3.CelMatcher expr_match: # Shortened for illustration purposes. Here should be parsed CEL expression: # request.headers['user_group'] == 'admin' parsed_expr: {} on_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings bucket_id_builder: bucket_id_builder: acl: string_value: admin_users # Catch-all clause for the requests not matched by any of the matchers. # In this example, deny all requests. on_no_match: action: typed_config: '@type': type.googleapis.com/envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings no_assignment_behavior: fallback_rate_limit: blanket_rule: DENY_ALL .. attention:: The first matched group wins. Once the request is matched into a bucket, matcher evaluation ends. Use ``on_no_match`` field to assign the catch-all bucket. If a request is not matched into any bucket, and there's no ``on_no_match`` field configured, the request will be ALLOWED by default. It will NOT be reported to the RLQS server. Refer to :ref:`Unified Matcher API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>` documentation for more information on the matcher trees.
.xds.type.matcher.v3.Matcher bucket_matchers = 3 [(.validate.rules) = { ... }
-
hasFilterEnabled
public boolean hasFilterEnabled()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
- Specified by:
hasFilterEnabled
in interfaceRateLimitQuotaFilterConfigOrBuilder
- 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 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
- Specified by:
getFilterEnabled
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- The filterEnabled.
-
setFilterEnabled
public RateLimitQuotaFilterConfig.Builder setFilterEnabled(RuntimeFractionalPercent value)
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
-
setFilterEnabled
public RateLimitQuotaFilterConfig.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 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
-
mergeFilterEnabled
public RateLimitQuotaFilterConfig.Builder mergeFilterEnabled(RuntimeFractionalPercent value)
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
-
clearFilterEnabled
public RateLimitQuotaFilterConfig.Builder clearFilterEnabled()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 100% of requests.
.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 100% of requests.
.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 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
- Specified by:
getFilterEnabledOrBuilder
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
getFilterEnabledFieldBuilder
private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,RuntimeFractionalPercent.Builder,RuntimeFractionalPercentOrBuilder> getFilterEnabledFieldBuilder()
If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 4;
-
hasFilterEnforced
public boolean hasFilterEnforced()
If set, this will enforce the rate limit decisions for the given fraction of requests. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
- Specified by:
hasFilterEnforced
in interfaceRateLimitQuotaFilterConfigOrBuilder
- 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. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
- Specified by:
getFilterEnforced
in interfaceRateLimitQuotaFilterConfigOrBuilder
- Returns:
- The filterEnforced.
-
setFilterEnforced
public RateLimitQuotaFilterConfig.Builder setFilterEnforced(RuntimeFractionalPercent value)
If set, this will enforce the rate limit decisions for the given fraction of requests. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
-
setFilterEnforced
public RateLimitQuotaFilterConfig.Builder setFilterEnforced(RuntimeFractionalPercent.Builder builderForValue)
If set, this will enforce the rate limit decisions for the given fraction of requests. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
-
mergeFilterEnforced
public RateLimitQuotaFilterConfig.Builder mergeFilterEnforced(RuntimeFractionalPercent value)
If set, this will enforce the rate limit decisions for the given fraction of requests. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
-
clearFilterEnforced
public RateLimitQuotaFilterConfig.Builder clearFilterEnforced()
If set, this will enforce the rate limit decisions for the given fraction of requests. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.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. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.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. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
- Specified by:
getFilterEnforcedOrBuilder
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
getFilterEnforcedFieldBuilder
private com.google.protobuf.SingleFieldBuilder<RuntimeFractionalPercent,RuntimeFractionalPercent.Builder,RuntimeFractionalPercentOrBuilder> getFilterEnforcedFieldBuilder()
If set, this will enforce the rate limit decisions for the given fraction of requests. For requests that are not enforced the filter will still obtain the quota and include it in the load computation, however the request will always be allowed regardless of the outcome of quota application. This allows validation or testing of the rate limiting service infrastructure without disrupting existing traffic. Note: this only applies to the fraction of enabled requests. Defaults to 100% of requests.
.envoy.config.core.v3.RuntimeFractionalPercent filter_enforced = 5;
-
ensureRequestHeadersToAddWhenNotEnforcedIsMutable
private void ensureRequestHeadersToAddWhenNotEnforcedIsMutable()
-
getRequestHeadersToAddWhenNotEnforcedList
public java.util.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 = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddWhenNotEnforcedList
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
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 = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddWhenNotEnforcedCount
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
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 = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddWhenNotEnforced
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
setRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
setRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
addRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
addRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
addRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
addRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
addAllRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.Builder addAllRequestHeadersToAddWhenNotEnforced(java.lang.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 = 6 [(.validate.rules) = { ... }
-
clearRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.validate.rules) = { ... }
-
removeRequestHeadersToAddWhenNotEnforced
public RateLimitQuotaFilterConfig.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 = 6 [(.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 = 6 [(.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 = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddWhenNotEnforcedOrBuilder
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
getRequestHeadersToAddWhenNotEnforcedOrBuilderList
public java.util.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 = 6 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToAddWhenNotEnforcedOrBuilderList
in interfaceRateLimitQuotaFilterConfigOrBuilder
-
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 = 6 [(.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 = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToAddWhenNotEnforcedBuilderList
public java.util.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 = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToAddWhenNotEnforcedFieldBuilder
private com.google.protobuf.RepeatedFieldBuilder<HeaderValueOption,HeaderValueOption.Builder,HeaderValueOptionOrBuilder> getRequestHeadersToAddWhenNotEnforcedFieldBuilder()
-
-