io.envoyproxy.envoy.extensions.filters.http.local_ratelimit.v3

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: 7]
 

Protobuf type envoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit

Method Summary

Modifier and Type	Method and Description
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.
LocalRateLimit.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
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.
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.
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.
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.
HeaderValueOption.Builder	addResponseHeadersToAddBuilder() Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.
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.
LocalRateLimit	build()
LocalRateLimit	buildPartial()
LocalRateLimit.Builder	clear()
LocalRateLimit.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
LocalRateLimit.Builder	clearFilterEnabled() If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.
LocalRateLimit.Builder	clearFilterEnforced() If set, this will enforce the rate limit decisions for the given fraction of requests.
LocalRateLimit.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
LocalRateLimit.Builder	clearResponseHeadersToAdd() Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.
LocalRateLimit.Builder	clearStatPrefix() The human readable prefix to use when emitting stats.
LocalRateLimit.Builder	clearStatus() This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.
LocalRateLimit.Builder	clearTokenBucket() The token bucket configuration to use for rate limiting requests that are processed by this filter.
LocalRateLimit.Builder	clone()
LocalRateLimit	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
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.
RuntimeFractionalPercentOrBuilder	getFilterEnforcedOrBuilder() If set, this will enforce the rate limit decisions for the given fraction of requests.
HeaderValueOption	getResponseHeadersToAdd(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.
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.
List<HeaderValueOption.Builder>	getResponseHeadersToAddBuilderList() Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.
int	getResponseHeadersToAddCount() 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.
HeaderValueOptionOrBuilder	getResponseHeadersToAddOrBuilder(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.
List<? extends HeaderValueOptionOrBuilder>	getResponseHeadersToAddOrBuilderList() Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.
String	getStatPrefix() The human readable prefix to use when emitting stats.
com.google.protobuf.ByteString	getStatPrefixBytes() The human readable prefix to use when emitting stats.
HttpStatus	getStatus() This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.
HttpStatus.Builder	getStatusBuilder() This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.
HttpStatusOrBuilder	getStatusOrBuilder() This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.
TokenBucket	getTokenBucket() The token bucket configuration to use for rate limiting requests that are processed by this filter.
TokenBucket.Builder	getTokenBucketBuilder() The token bucket configuration to use for rate limiting requests that are processed by this filter.
TokenBucketOrBuilder	getTokenBucketOrBuilder() The token bucket configuration to use for rate limiting requests that are processed by this filter.
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	hasStatus() This field allows for a custom HTTP response status code to the downstream client when the request has been rate limited.
boolean	hasTokenBucket() The token bucket configuration to use for rate limiting requests that are processed by this filter.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LocalRateLimit.Builder	mergeFilterEnabled(RuntimeFractionalPercent value) If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.
LocalRateLimit.Builder	mergeFilterEnforced(RuntimeFractionalPercent value) If set, this will enforce the rate limit decisions for the given fraction of requests.
LocalRateLimit.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LocalRateLimit.Builder	mergeFrom(LocalRateLimit other)
LocalRateLimit.Builder	mergeFrom(com.google.protobuf.Message other)
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.
LocalRateLimit.Builder	mergeTokenBucket(TokenBucket value) The token bucket configuration to use for rate limiting requests that are processed by this filter.
LocalRateLimit.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
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.
LocalRateLimit.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LocalRateLimit.Builder	setFilterEnabled(RuntimeFractionalPercent.Builder builderForValue) If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.
LocalRateLimit.Builder	setFilterEnabled(RuntimeFractionalPercent value) If set, this will enable -- but not necessarily enforce -- the rate limit for the given fraction of requests.
LocalRateLimit.Builder	setFilterEnforced(RuntimeFractionalPercent.Builder builderForValue) If set, this will enforce the rate limit decisions for the given fraction of requests.
LocalRateLimit.Builder	setFilterEnforced(RuntimeFractionalPercent value) If set, this will enforce the rate limit decisions for the given fraction of requests.
LocalRateLimit.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
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.
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.
LocalRateLimit.Builder	setStatPrefix(String value) The human readable prefix to use when emitting stats.
LocalRateLimit.Builder	setStatPrefixBytes(com.google.protobuf.ByteString value) The human readable prefix to use when emitting stats.
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.
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.
LocalRateLimit.Builder	setTokenBucket(TokenBucket.Builder builderForValue) The token bucket configuration to use for rate limiting requests that are processed by this filter.
LocalRateLimit.Builder	setTokenBucket(TokenBucket value) The token bucket configuration to use for rate limiting requests that are processed by this filter.
LocalRateLimit.Builder	setUnknownFields(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, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

clear

public LocalRateLimit.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

getDefaultInstanceForType

public LocalRateLimit getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LocalRateLimit build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public LocalRateLimit buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public LocalRateLimit.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

setField

public LocalRateLimit.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

clearField

public LocalRateLimit.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

clearOneof

public LocalRateLimit.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

setRepeatedField

public LocalRateLimit.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

addRepeatedField

public LocalRateLimit.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

mergeFrom

public LocalRateLimit.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LocalRateLimit.Builder>

mergeFrom

public LocalRateLimit.Builder mergeFrom(LocalRateLimit other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.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:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<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:

getStatPrefix in interface LocalRateLimitOrBuilder

getStatPrefixBytes

public com.google.protobuf.ByteString getStatPrefixBytes()

 The human readable prefix to use when emitting stats.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefixBytes in interface LocalRateLimitOrBuilder

setStatPrefix

public LocalRateLimit.Builder setStatPrefix(String value)

 The human readable prefix to use when emitting stats.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

clearStatPrefix

public LocalRateLimit.Builder clearStatPrefix()

 The human readable prefix to use when emitting stats.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

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) = { ... }

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:

hasStatus in interface LocalRateLimitOrBuilder

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:

getStatus in interface LocalRateLimitOrBuilder

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:

getStatusOrBuilder in interface LocalRateLimitOrBuilder

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_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 3;

Specified by:

hasTokenBucket in interface LocalRateLimitOrBuilder

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_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 3;

Specified by:

getTokenBucket in interface LocalRateLimitOrBuilder

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_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_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_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_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_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_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 3;

Specified by:

getTokenBucketOrBuilder in interface LocalRateLimitOrBuilder

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:

hasFilterEnabled in interface LocalRateLimitOrBuilder

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:

getFilterEnabled in interface LocalRateLimitOrBuilder

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:

getFilterEnabledOrBuilder in interface LocalRateLimitOrBuilder

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:

hasFilterEnforced in interface LocalRateLimitOrBuilder

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:

getFilterEnforced in interface LocalRateLimitOrBuilder

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:

getFilterEnforcedOrBuilder in interface LocalRateLimitOrBuilder

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.
 

repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }

Specified by:

getResponseHeadersToAddList in interface LocalRateLimitOrBuilder

getResponseHeadersToAddCount

public int getResponseHeadersToAddCount()

 Specifies a list of HTTP headers that should be added to each response for requests that
 have been rate limited.
 

repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }

Specified by:

getResponseHeadersToAddCount in interface LocalRateLimitOrBuilder

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.
 

repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }

Specified by:

getResponseHeadersToAdd in interface LocalRateLimitOrBuilder

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }

Specified by:

getResponseHeadersToAddOrBuilder in interface LocalRateLimitOrBuilder

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.
 

repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }

Specified by:

getResponseHeadersToAddOrBuilderList in interface LocalRateLimitOrBuilder

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.
 

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.
 

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.
 

repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 6 [(.validate.rules) = { ... }

setUnknownFields

public final LocalRateLimit.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

mergeUnknownFields

public final LocalRateLimit.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>