public final class LocalRateLimit extends com.google.protobuf.GeneratedMessageV3 implements LocalRateLimitOrBuilder
[#next-free-field: 7]Protobuf type
envoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit| Modifier and Type | Class and Description |
|---|---|
static class |
LocalRateLimit.Builder
[#next-free-field: 7]
Protobuf type
envoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
FILTER_ENABLED_FIELD_NUMBER |
static int |
FILTER_ENFORCED_FIELD_NUMBER |
static int |
RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER |
static int |
STAT_PREFIX_FIELD_NUMBER |
static int |
STATUS_FIELD_NUMBER |
static int |
TOKEN_BUCKET_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static LocalRateLimit |
getDefaultInstance() |
LocalRateLimit |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<LocalRateLimit> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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.
|
int |
hashCode() |
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() |
static LocalRateLimit.Builder |
newBuilder() |
static LocalRateLimit.Builder |
newBuilder(LocalRateLimit prototype) |
LocalRateLimit.Builder |
newBuilderForType() |
protected LocalRateLimit.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LocalRateLimit |
parseDelimitedFrom(InputStream input) |
static LocalRateLimit |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LocalRateLimit |
parseFrom(byte[] data) |
static LocalRateLimit |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LocalRateLimit |
parseFrom(ByteBuffer data) |
static LocalRateLimit |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LocalRateLimit |
parseFrom(com.google.protobuf.ByteString data) |
static LocalRateLimit |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LocalRateLimit |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LocalRateLimit |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LocalRateLimit |
parseFrom(InputStream input) |
static LocalRateLimit |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LocalRateLimit> |
parser() |
LocalRateLimit.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int STAT_PREFIX_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
public static final int TOKEN_BUCKET_FIELD_NUMBER
public static final int FILTER_ENABLED_FIELD_NUMBER
public static final int FILTER_ENFORCED_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getStatPrefix()
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }getStatPrefix in interface LocalRateLimitOrBuilderpublic com.google.protobuf.ByteString getStatPrefixBytes()
The human readable prefix to use when emitting stats.
string stat_prefix = 1 [(.validate.rules) = { ... }getStatPrefixBytes in interface LocalRateLimitOrBuilderpublic 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;hasStatus in interface LocalRateLimitOrBuilderpublic 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;getStatus in interface LocalRateLimitOrBuilderpublic 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;getStatusOrBuilder in interface LocalRateLimitOrBuilderpublic 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;hasTokenBucket in interface LocalRateLimitOrBuilderpublic 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;getTokenBucket in interface LocalRateLimitOrBuilderpublic 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;getTokenBucketOrBuilder in interface LocalRateLimitOrBuilderpublic 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;hasFilterEnabled in interface LocalRateLimitOrBuilderpublic 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;getFilterEnabled in interface LocalRateLimitOrBuilderpublic 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;getFilterEnabledOrBuilder in interface LocalRateLimitOrBuilderpublic 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;hasFilterEnforced in interface LocalRateLimitOrBuilderpublic 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;getFilterEnforced in interface LocalRateLimitOrBuilderpublic 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;getFilterEnforcedOrBuilder in interface LocalRateLimitOrBuilderpublic 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) = { ... }getResponseHeadersToAddList in interface LocalRateLimitOrBuilderpublic 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) = { ... }getResponseHeadersToAddOrBuilderList in interface LocalRateLimitOrBuilderpublic 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) = { ... }getResponseHeadersToAddCount in interface LocalRateLimitOrBuilderpublic 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) = { ... }getResponseHeadersToAdd in interface LocalRateLimitOrBuilderpublic 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) = { ... }getResponseHeadersToAddOrBuilder in interface LocalRateLimitOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static LocalRateLimit parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LocalRateLimit parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LocalRateLimit parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LocalRateLimit parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LocalRateLimit parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LocalRateLimit parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LocalRateLimit parseFrom(InputStream input) throws IOException
IOExceptionpublic static LocalRateLimit parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static LocalRateLimit parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static LocalRateLimit parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static LocalRateLimit parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static LocalRateLimit parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic LocalRateLimit.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static LocalRateLimit.Builder newBuilder()
public static LocalRateLimit.Builder newBuilder(LocalRateLimit prototype)
public LocalRateLimit.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected LocalRateLimit.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static LocalRateLimit getDefaultInstance()
public static com.google.protobuf.Parser<LocalRateLimit> parser()
public com.google.protobuf.Parser<LocalRateLimit> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public LocalRateLimit getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.