Class RateLimit
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.RateLimit
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimitOrBuilder
,Serializable
public final class RateLimit
extends com.google.protobuf.GeneratedMessage
implements RateLimitOrBuilder
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`. Also applies to Local rate limiting :ref:`using descriptors <config_http_filters_local_rate_limit_descriptors>`.Protobuf type
envoy.config.route.v3.RateLimit
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
[#next-free-field: 12]static interface
static final class
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.static final class
Protobuf typeenvoy.config.route.v3.RateLimit.Override
static interface
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
<RateLimit.Action> static final int
private int
private static final RateLimit
static final int
private Object
private RateLimit.Override
static final int
private byte
private static final com.google.protobuf.Parser
<RateLimit> private static final long
private com.google.protobuf.UInt32Value
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
getActions
(int index) A list of actions that are to be applied for this rate limit configuration.int
A list of actions that are to be applied for this rate limit configuration.A list of actions that are to be applied for this rate limit configuration.getActionsOrBuilder
(int index) A list of actions that are to be applied for this rate limit configuration.List
<? extends RateLimit.ActionOrBuilder> A list of actions that are to be applied for this rate limit configuration.static RateLimit
static final com.google.protobuf.Descriptors.Descriptor
The key to be set in runtime to disable this rate limit configuration.com.google.protobuf.ByteString
The key to be set in runtime to disable this rate limit configuration.getLimit()
An optional limit override to be appended to the descriptor produced by this rate limit configuration.An optional limit override to be appended to the descriptor produced by this rate limit configuration.com.google.protobuf.Parser
<RateLimit> int
com.google.protobuf.UInt32Value
getStage()
Refers to the stage set in the filter.com.google.protobuf.UInt32ValueOrBuilder
Refers to the stage set in the filter.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.GeneratedMessage.FieldAccessorTable
final boolean
static RateLimit.Builder
static RateLimit.Builder
newBuilder
(RateLimit prototype) protected RateLimit.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) 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
(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 RateLimit
parseFrom
(ByteBuffer data) static RateLimit
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<RateLimit> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
STAGE_FIELD_NUMBER
public static final int STAGE_FIELD_NUMBER- See Also:
-
stage_
private com.google.protobuf.UInt32Value stage_ -
DISABLE_KEY_FIELD_NUMBER
public static final int DISABLE_KEY_FIELD_NUMBER- See Also:
-
disableKey_
-
ACTIONS_FIELD_NUMBER
public static final int ACTIONS_FIELD_NUMBER- See Also:
-
actions_
-
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER- See Also:
-
limit_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
RateLimit
private RateLimit(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
RateLimit
private RateLimit()
-
-
Method Details
-
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
-
hasStage
public 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) = { ... }
- Specified by:
hasStage
in interfaceRateLimitOrBuilder
- Returns:
- Whether the stage field is set.
-
getStage
public 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) = { ... }
- Specified by:
getStage
in interfaceRateLimitOrBuilder
- Returns:
- The stage.
-
getStageOrBuilder
public 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) = { ... }
- Specified by:
getStageOrBuilder
in interfaceRateLimitOrBuilder
-
getDisableKey
The key to be set in runtime to disable this rate limit configuration.
string disable_key = 2;
- Specified by:
getDisableKey
in interfaceRateLimitOrBuilder
- Returns:
- The disableKey.
-
getDisableKeyBytes
public com.google.protobuf.ByteString getDisableKeyBytes()The key to be set in runtime to disable this rate limit configuration.
string disable_key = 2;
- Specified by:
getDisableKeyBytes
in interfaceRateLimitOrBuilder
- Returns:
- The bytes for disableKey.
-
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.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
- Specified by:
getActionsList
in interfaceRateLimitOrBuilder
-
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.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
- Specified by:
getActionsOrBuilderList
in interfaceRateLimitOrBuilder
-
getActionsCount
public 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.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
- Specified by:
getActionsCount
in interfaceRateLimitOrBuilder
-
getActions
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.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
- Specified by:
getActions
in interfaceRateLimitOrBuilder
-
getActionsOrBuilder
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.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
- Specified by:
getActionsOrBuilder
in interfaceRateLimitOrBuilder
-
hasLimit
public 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.v3.RateLimit.Override limit = 4;
- Specified by:
hasLimit
in interfaceRateLimitOrBuilder
- Returns:
- Whether the limit field is set.
-
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.v3.RateLimit.Override limit = 4;
- Specified by:
getLimit
in interfaceRateLimitOrBuilder
- Returns:
- The limit.
-
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.v3.RateLimit.Override limit = 4;
- Specified by:
getLimitOrBuilder
in interfaceRateLimitOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RateLimit parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RateLimit parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static RateLimit parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RateLimit parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimit.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-