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

Interface LocalRateLimitOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LocalRateLimit, LocalRateLimit.Builder

public interface LocalRateLimitOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
RuntimeFractionalPercent	getFilterEnabled() 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.
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.
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.
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getStatPrefix

String getStatPrefix()

 The human readable prefix to use when emitting stats.
 

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

getStatPrefixBytes

com.google.protobuf.ByteString getStatPrefixBytes()

 The human readable prefix to use when emitting stats.
 

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

hasStatus

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;

getStatus

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;

getStatusOrBuilder

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;

hasTokenBucket

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;

getTokenBucket

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;

getTokenBucketOrBuilder

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;

hasFilterEnabled

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;

getFilterEnabled

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;

getFilterEnabledOrBuilder

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;

hasFilterEnforced

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;

getFilterEnforced

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;

getFilterEnforcedOrBuilder

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;

getResponseHeadersToAddList

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

getResponseHeadersToAdd

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

getResponseHeadersToAddCount

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

getResponseHeadersToAddOrBuilderList

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

getResponseHeadersToAddOrBuilder

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