public final class RateLimit extends com.google.protobuf.GeneratedMessageV3 implements RateLimitOrBuilder
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.Protobuf type
envoy.config.route.v4alpha.RateLimit| Modifier and Type | Class and Description |
|---|---|
static class |
RateLimit.Action
[#next-free-field: 10]
Protobuf type
envoy.config.route.v4alpha.RateLimit.Action |
static interface |
RateLimit.ActionOrBuilder |
static class |
RateLimit.Builder
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
|
static class |
RateLimit.Override
Protobuf type
envoy.config.route.v4alpha.RateLimit.Override |
static interface |
RateLimit.OverrideOrBuilder |
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 |
ACTIONS_FIELD_NUMBER |
static int |
DISABLE_KEY_FIELD_NUMBER |
static int |
LIMIT_FIELD_NUMBER |
static int |
STAGE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
RateLimit.Action |
getActions(int index)
A list of actions that are to be applied for this rate limit configuration.
|
int |
getActionsCount()
A list of actions that are to be applied for this rate limit configuration.
|
List<RateLimit.Action> |
getActionsList()
A list of actions that are to be applied for this rate limit configuration.
|
RateLimit.ActionOrBuilder |
getActionsOrBuilder(int index)
A list of actions that are to be applied for this rate limit configuration.
|
List<? extends RateLimit.ActionOrBuilder> |
getActionsOrBuilderList()
A list of actions that are to be applied for this rate limit configuration.
|
static RateLimit |
getDefaultInstance() |
RateLimit |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisableKey()
The key to be set in runtime to disable this rate limit configuration.
|
com.google.protobuf.ByteString |
getDisableKeyBytes()
The key to be set in runtime to disable this rate limit configuration.
|
RateLimit.Override |
getLimit()
An optional limit override to be appended to the descriptor produced by this
rate limit configuration.
|
RateLimit.OverrideOrBuilder |
getLimitOrBuilder()
An optional limit override to be appended to the descriptor produced by this
rate limit configuration.
|
com.google.protobuf.Parser<RateLimit> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UInt32Value |
getStage()
Refers to the stage set in the filter.
|
com.google.protobuf.UInt32ValueOrBuilder |
getStageOrBuilder()
Refers to the stage set in the filter.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasLimit()
An optional limit override to be appended to the descriptor produced by this
rate limit configuration.
|
boolean |
hasStage()
Refers to the stage set in the filter.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static RateLimit.Builder |
newBuilder() |
static RateLimit.Builder |
newBuilder(RateLimit prototype) |
RateLimit.Builder |
newBuilderForType() |
protected RateLimit.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static RateLimit |
parseDelimitedFrom(InputStream input) |
static RateLimit |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimit |
parseFrom(byte[] data) |
static RateLimit |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimit |
parseFrom(ByteBuffer data) |
static RateLimit |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimit |
parseFrom(com.google.protobuf.ByteString data) |
static RateLimit |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimit |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RateLimit |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimit |
parseFrom(InputStream input) |
static RateLimit |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RateLimit> |
parser() |
RateLimit.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 STAGE_FIELD_NUMBER
public static final int DISABLE_KEY_FIELD_NUMBER
public static final int ACTIONS_FIELD_NUMBER
public static final int LIMIT_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 boolean hasStage()
Refers to the stage set in the filter. The rate limit configuration only applies to filters with the same stage number. The default stage number is 0. .. note:: The filter supports a range of 0 - 10 inclusively for stage numbers.
.google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }hasStage in interface RateLimitOrBuilderpublic com.google.protobuf.UInt32Value getStage()
Refers to the stage set in the filter. The rate limit configuration only applies to filters with the same stage number. The default stage number is 0. .. note:: The filter supports a range of 0 - 10 inclusively for stage numbers.
.google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }getStage in interface RateLimitOrBuilderpublic com.google.protobuf.UInt32ValueOrBuilder getStageOrBuilder()
Refers to the stage set in the filter. The rate limit configuration only applies to filters with the same stage number. The default stage number is 0. .. note:: The filter supports a range of 0 - 10 inclusively for stage numbers.
.google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }getStageOrBuilder in interface RateLimitOrBuilderpublic String getDisableKey()
The key to be set in runtime to disable this rate limit configuration.
string disable_key = 2;getDisableKey in interface RateLimitOrBuilderpublic com.google.protobuf.ByteString getDisableKeyBytes()
The key to be set in runtime to disable this rate limit configuration.
string disable_key = 2;getDisableKeyBytes in interface RateLimitOrBuilderpublic List<RateLimit.Action> getActionsList()
A list of actions that are to be applied for this rate limit configuration. Order matters as the actions are processed sequentially and the descriptor is composed by appending descriptor entries in that sequence. If an action cannot append a descriptor entry, no descriptor is generated for the configuration. See :ref:`composing actions <config_http_filters_rate_limit_composing_actions>` for additional documentation.
repeated .envoy.config.route.v4alpha.RateLimit.Action actions = 3 [(.validate.rules) = { ... }getActionsList in interface RateLimitOrBuilderpublic List<? extends RateLimit.ActionOrBuilder> getActionsOrBuilderList()
A list of actions that are to be applied for this rate limit configuration. Order matters as the actions are processed sequentially and the descriptor is composed by appending descriptor entries in that sequence. If an action cannot append a descriptor entry, no descriptor is generated for the configuration. See :ref:`composing actions <config_http_filters_rate_limit_composing_actions>` for additional documentation.
repeated .envoy.config.route.v4alpha.RateLimit.Action actions = 3 [(.validate.rules) = { ... }getActionsOrBuilderList in interface RateLimitOrBuilderpublic int getActionsCount()
A list of actions that are to be applied for this rate limit configuration. Order matters as the actions are processed sequentially and the descriptor is composed by appending descriptor entries in that sequence. If an action cannot append a descriptor entry, no descriptor is generated for the configuration. See :ref:`composing actions <config_http_filters_rate_limit_composing_actions>` for additional documentation.
repeated .envoy.config.route.v4alpha.RateLimit.Action actions = 3 [(.validate.rules) = { ... }getActionsCount in interface RateLimitOrBuilderpublic RateLimit.Action getActions(int index)
A list of actions that are to be applied for this rate limit configuration. Order matters as the actions are processed sequentially and the descriptor is composed by appending descriptor entries in that sequence. If an action cannot append a descriptor entry, no descriptor is generated for the configuration. See :ref:`composing actions <config_http_filters_rate_limit_composing_actions>` for additional documentation.
repeated .envoy.config.route.v4alpha.RateLimit.Action actions = 3 [(.validate.rules) = { ... }getActions in interface RateLimitOrBuilderpublic RateLimit.ActionOrBuilder getActionsOrBuilder(int index)
A list of actions that are to be applied for this rate limit configuration. Order matters as the actions are processed sequentially and the descriptor is composed by appending descriptor entries in that sequence. If an action cannot append a descriptor entry, no descriptor is generated for the configuration. See :ref:`composing actions <config_http_filters_rate_limit_composing_actions>` for additional documentation.
repeated .envoy.config.route.v4alpha.RateLimit.Action actions = 3 [(.validate.rules) = { ... }getActionsOrBuilder in interface RateLimitOrBuilderpublic boolean hasLimit()
An optional limit override to be appended to the descriptor produced by this rate limit configuration. If the override value is invalid or cannot be resolved from metadata, no override is provided. See :ref:`rate limit override <config_http_filters_rate_limit_rate_limit_override>` for more information.
.envoy.config.route.v4alpha.RateLimit.Override limit = 4;hasLimit in interface RateLimitOrBuilderpublic RateLimit.Override getLimit()
An optional limit override to be appended to the descriptor produced by this rate limit configuration. If the override value is invalid or cannot be resolved from metadata, no override is provided. See :ref:`rate limit override <config_http_filters_rate_limit_rate_limit_override>` for more information.
.envoy.config.route.v4alpha.RateLimit.Override limit = 4;getLimit in interface RateLimitOrBuilderpublic RateLimit.OverrideOrBuilder getLimitOrBuilder()
An optional limit override to be appended to the descriptor produced by this rate limit configuration. If the override value is invalid or cannot be resolved from metadata, no override is provided. See :ref:`rate limit override <config_http_filters_rate_limit_rate_limit_override>` for more information.
.envoy.config.route.v4alpha.RateLimit.Override limit = 4;getLimitOrBuilder in interface RateLimitOrBuilderpublic 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 RateLimit parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimit parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimit parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimit parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimit parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimit parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimit parseFrom(InputStream input) throws IOException
IOExceptionpublic static RateLimit parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RateLimit parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RateLimit parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RateLimit parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RateLimit parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RateLimit.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RateLimit.Builder newBuilder()
public static RateLimit.Builder newBuilder(RateLimit prototype)
public RateLimit.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RateLimit.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RateLimit getDefaultInstance()
public static com.google.protobuf.Parser<RateLimit> parser()
public com.google.protobuf.Parser<RateLimit> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RateLimit getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.