envoy.api.v2.route

Class RouteOuterClass.RateLimit

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.api.v2.route.RouteOuterClass.RateLimit

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteOuterClass.RateLimitOrBuilder, Serializable

Enclosing class:

RouteOuterClass

public static final class RouteOuterClass.RateLimit
extends com.google.protobuf.GeneratedMessageV3
implements RouteOuterClass.RateLimitOrBuilder

 Global rate limiting :ref:`architecture overview <arch_overview_rate_limit>`.
 

Protobuf type envoy.api.v2.route.RateLimit

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteOuterClass.RateLimit.Action Protobuf type envoy.api.v2.route.RateLimit.Action
static interface	RouteOuterClass.RateLimit.ActionOrBuilder
static class	RouteOuterClass.RateLimit.Builder Global rate limiting :ref:`architecture overview <arch_overview_rate_limit>`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIONS_FIELD_NUMBER
static int	DISABLE_KEY_FIELD_NUMBER
static int	STAGE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
RouteOuterClass.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<RouteOuterClass.RateLimit.Action>	getActionsList() A list of actions that are to be applied for this rate limit configuration.
RouteOuterClass.RateLimit.ActionOrBuilder	getActionsOrBuilder(int index) A list of actions that are to be applied for this rate limit configuration.
List<? extends RouteOuterClass.RateLimit.ActionOrBuilder>	getActionsOrBuilderList() A list of actions that are to be applied for this rate limit configuration.
static RouteOuterClass.RateLimit	getDefaultInstance()
RouteOuterClass.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.
com.google.protobuf.Parser<RouteOuterClass.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	hasStage() Refers to the stage set in the filter.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RouteOuterClass.RateLimit.Builder	newBuilder()
static RouteOuterClass.RateLimit.Builder	newBuilder(RouteOuterClass.RateLimit prototype)
RouteOuterClass.RateLimit.Builder	newBuilderForType()
protected RouteOuterClass.RateLimit.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RouteOuterClass.RateLimit	parseDelimitedFrom(InputStream input)
static RouteOuterClass.RateLimit	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.RateLimit	parseFrom(byte[] data)
static RouteOuterClass.RateLimit	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.RateLimit	parseFrom(ByteBuffer data)
static RouteOuterClass.RateLimit	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.RateLimit	parseFrom(com.google.protobuf.ByteString data)
static RouteOuterClass.RateLimit	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.RateLimit	parseFrom(com.google.protobuf.CodedInputStream input)
static RouteOuterClass.RateLimit	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RouteOuterClass.RateLimit	parseFrom(InputStream input)
static RouteOuterClass.RateLimit	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RouteOuterClass.RateLimit>	parser()
RouteOuterClass.RateLimit.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STAGE_FIELD_NUMBER

public static final int STAGE_FIELD_NUMBER

See Also:

Constant Field Values

DISABLE_KEY_FIELD_NUMBER

public static final int DISABLE_KEY_FIELD_NUMBER

See Also:

Constant Field Values

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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 interface RouteOuterClass.RateLimitOrBuilder

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 interface RouteOuterClass.RateLimitOrBuilder

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 interface RouteOuterClass.RateLimitOrBuilder

getDisableKey

public String getDisableKey()

 The key to be set in runtime to disable this rate limit configuration.
 

string disable_key = 2;

Specified by:

getDisableKey in interface RouteOuterClass.RateLimitOrBuilder

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 interface RouteOuterClass.RateLimitOrBuilder

getActionsList

public List<RouteOuterClass.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.api.v2.route.RateLimit.Action actions = 3 [(.validate.rules) = { ... }

Specified by:

getActionsList in interface RouteOuterClass.RateLimitOrBuilder

getActionsOrBuilderList

public List<? extends RouteOuterClass.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.api.v2.route.RateLimit.Action actions = 3 [(.validate.rules) = { ... }

Specified by:

getActionsOrBuilderList in interface RouteOuterClass.RateLimitOrBuilder

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.api.v2.route.RateLimit.Action actions = 3 [(.validate.rules) = { ... }

Specified by:

getActionsCount in interface RouteOuterClass.RateLimitOrBuilder

getActions

public RouteOuterClass.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.api.v2.route.RateLimit.Action actions = 3 [(.validate.rules) = { ... }

Specified by:

getActions in interface RouteOuterClass.RateLimitOrBuilder

getActionsOrBuilder

public RouteOuterClass.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.api.v2.route.RateLimit.Action actions = 3 [(.validate.rules) = { ... }

Specified by:

getActionsOrBuilder in interface RouteOuterClass.RateLimitOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RouteOuterClass.RateLimit parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.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 RouteOuterClass.RateLimit parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static RouteOuterClass.RateLimit parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static RouteOuterClass.RateLimit parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static RouteOuterClass.RateLimit parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public RouteOuterClass.RateLimit.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RouteOuterClass.RateLimit.Builder newBuilder()

newBuilder

public static RouteOuterClass.RateLimit.Builder newBuilder(RouteOuterClass.RateLimit prototype)

toBuilder

public RouteOuterClass.RateLimit.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RouteOuterClass.RateLimit.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RouteOuterClass.RateLimit getDefaultInstance()

parser

public static com.google.protobuf.Parser<RouteOuterClass.RateLimit> parser()

getParserForType

public com.google.protobuf.Parser<RouteOuterClass.RateLimit> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RouteOuterClass.RateLimit getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder