Package io.envoyproxy.envoy.api.v2.route

Class RateLimit.Action

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.route.RateLimit.Action

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.ActionOrBuilder, Serializable

Enclosing class:

RateLimit

public static final class RateLimit.Action
extends com.google.protobuf.GeneratedMessageV3
implements RateLimit.ActionOrBuilder

 [#next-free-field: 7]
 

Protobuf type envoy.api.v2.route.RateLimit.Action

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RateLimit.Action.ActionSpecifierCase
static final class	RateLimit.Action.Builder	[#next-free-field: 7]
static final class	RateLimit.Action.DestinationCluster	The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("destination_cluster", "<routed target cluster>") Once a request matches against a route table rule, a routed cluster is determined by one of the following :ref:`route table configuration <envoy_api_msg_RouteConfiguration>` settings: * :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` indicates the upstream cluster to route to
static interface	RateLimit.Action.DestinationClusterOrBuilder
static final class	RateLimit.Action.GenericKey	The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("generic_key", "<descriptor_value>")
static interface	RateLimit.Action.GenericKeyOrBuilder
static final class	RateLimit.Action.HeaderValueMatch	The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("header_match", "<descriptor_value>")
static interface	RateLimit.Action.HeaderValueMatchOrBuilder
static final class	RateLimit.Action.RemoteAddress	The following descriptor entry is appended to the descriptor and is populated using the trusted address from :ref:`x-forwarded-for <config_http_conn_man_headers_x-forwarded-for>`: .. code-block:: cpp ("remote_address", "<trusted address from x-forwarded-for>")
static interface	RateLimit.Action.RemoteAddressOrBuilder
static final class	RateLimit.Action.RequestHeaders	The following descriptor entry is appended when a header contains a key that matches the *header_name*: .. code-block:: cpp ("<descriptor_key>", "<header_value_queried_from_header>")
static interface	RateLimit.Action.RequestHeadersOrBuilder
static final class	RateLimit.Action.SourceCluster	The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("source_cluster", "<local service cluster>") <local service cluster> is derived from the :option:`--service-cluster` option.
static interface	RateLimit.Action.SourceClusterOrBuilder

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DESTINATION_CLUSTER_FIELD_NUMBER
static final int	GENERIC_KEY_FIELD_NUMBER
static final int	HEADER_VALUE_MATCH_FIELD_NUMBER
static final int	REMOTE_ADDRESS_FIELD_NUMBER
static final int	REQUEST_HEADERS_FIELD_NUMBER
static final int	SOURCE_CLUSTER_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	Description
boolean	equals(Object obj)
RateLimit.Action.ActionSpecifierCase	getActionSpecifierCase()
static RateLimit.Action	getDefaultInstance()
RateLimit.Action	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RateLimit.Action.DestinationCluster	getDestinationCluster()	Rate limit on destination cluster.
RateLimit.Action.DestinationClusterOrBuilder	getDestinationClusterOrBuilder()	Rate limit on destination cluster.
RateLimit.Action.GenericKey	getGenericKey()	Rate limit on a generic key.
RateLimit.Action.GenericKeyOrBuilder	getGenericKeyOrBuilder()	Rate limit on a generic key.
RateLimit.Action.HeaderValueMatch	getHeaderValueMatch()	Rate limit on the existence of request headers.
RateLimit.Action.HeaderValueMatchOrBuilder	getHeaderValueMatchOrBuilder()	Rate limit on the existence of request headers.
com.google.protobuf.Parser<RateLimit.Action>	getParserForType()
RateLimit.Action.RemoteAddress	getRemoteAddress()	Rate limit on remote address.
RateLimit.Action.RemoteAddressOrBuilder	getRemoteAddressOrBuilder()	Rate limit on remote address.
RateLimit.Action.RequestHeaders	getRequestHeaders()	Rate limit on request headers.
RateLimit.Action.RequestHeadersOrBuilder	getRequestHeadersOrBuilder()	Rate limit on request headers.
int	getSerializedSize()
RateLimit.Action.SourceCluster	getSourceCluster()	Rate limit on source cluster.
RateLimit.Action.SourceClusterOrBuilder	getSourceClusterOrBuilder()	Rate limit on source cluster.
boolean	hasDestinationCluster()	Rate limit on destination cluster.
boolean	hasGenericKey()	Rate limit on a generic key.
int	hashCode()
boolean	hasHeaderValueMatch()	Rate limit on the existence of request headers.
boolean	hasRemoteAddress()	Rate limit on remote address.
boolean	hasRequestHeaders()	Rate limit on request headers.
boolean	hasSourceCluster()	Rate limit on source cluster.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RateLimit.Action.Builder	newBuilder()
static RateLimit.Action.Builder	newBuilder(RateLimit.Action prototype)
RateLimit.Action.Builder	newBuilderForType()
protected RateLimit.Action.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RateLimit.Action	parseDelimitedFrom(InputStream input)
static RateLimit.Action	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action	parseFrom(byte[] data)
static RateLimit.Action	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action	parseFrom(com.google.protobuf.ByteString data)
static RateLimit.Action	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action	parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimit.Action	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action	parseFrom(InputStream input)
static RateLimit.Action	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action	parseFrom(ByteBuffer data)
static RateLimit.Action	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimit.Action>	parser()
RateLimit.Action.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, 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.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

SOURCE_CLUSTER_FIELD_NUMBER

public static final int SOURCE_CLUSTER_FIELD_NUMBER

See Also:

• Constant Field Values

DESTINATION_CLUSTER_FIELD_NUMBER

public static final int DESTINATION_CLUSTER_FIELD_NUMBER

See Also:

• Constant Field Values

REQUEST_HEADERS_FIELD_NUMBER

public static final int REQUEST_HEADERS_FIELD_NUMBER

See Also:

• Constant Field Values

REMOTE_ADDRESS_FIELD_NUMBER

public static final int REMOTE_ADDRESS_FIELD_NUMBER

See Also:

• Constant Field Values

GENERIC_KEY_FIELD_NUMBER

public static final int GENERIC_KEY_FIELD_NUMBER

See Also:

• Constant Field Values

HEADER_VALUE_MATCH_FIELD_NUMBER

public static final int HEADER_VALUE_MATCH_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance 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

getActionSpecifierCase

public RateLimit.Action.ActionSpecifierCase getActionSpecifierCase()

Specified by:

getActionSpecifierCase in interface RateLimit.ActionOrBuilder

hasSourceCluster

public boolean hasSourceCluster()

 Rate limit on source cluster.
 

.envoy.api.v2.route.RateLimit.Action.SourceCluster source_cluster = 1;

Specified by:

hasSourceCluster in interface RateLimit.ActionOrBuilder

Returns:

Whether the sourceCluster field is set.

getSourceCluster

public RateLimit.Action.SourceCluster getSourceCluster()

 Rate limit on source cluster.
 

.envoy.api.v2.route.RateLimit.Action.SourceCluster source_cluster = 1;

Specified by:

getSourceCluster in interface RateLimit.ActionOrBuilder

Returns:

The sourceCluster.

getSourceClusterOrBuilder

public RateLimit.Action.SourceClusterOrBuilder getSourceClusterOrBuilder()

 Rate limit on source cluster.
 

.envoy.api.v2.route.RateLimit.Action.SourceCluster source_cluster = 1;

Specified by:

getSourceClusterOrBuilder in interface RateLimit.ActionOrBuilder

hasDestinationCluster

public boolean hasDestinationCluster()

 Rate limit on destination cluster.
 

.envoy.api.v2.route.RateLimit.Action.DestinationCluster destination_cluster = 2;

Specified by:

hasDestinationCluster in interface RateLimit.ActionOrBuilder

Returns:

Whether the destinationCluster field is set.

getDestinationCluster

public RateLimit.Action.DestinationCluster getDestinationCluster()

 Rate limit on destination cluster.
 

.envoy.api.v2.route.RateLimit.Action.DestinationCluster destination_cluster = 2;

Specified by:

getDestinationCluster in interface RateLimit.ActionOrBuilder

Returns:

The destinationCluster.

getDestinationClusterOrBuilder

public RateLimit.Action.DestinationClusterOrBuilder getDestinationClusterOrBuilder()

 Rate limit on destination cluster.
 

.envoy.api.v2.route.RateLimit.Action.DestinationCluster destination_cluster = 2;

Specified by:

getDestinationClusterOrBuilder in interface RateLimit.ActionOrBuilder

hasRequestHeaders

public boolean hasRequestHeaders()

 Rate limit on request headers.
 

.envoy.api.v2.route.RateLimit.Action.RequestHeaders request_headers = 3;

Specified by:

hasRequestHeaders in interface RateLimit.ActionOrBuilder

Returns:

Whether the requestHeaders field is set.

getRequestHeaders

public RateLimit.Action.RequestHeaders getRequestHeaders()

 Rate limit on request headers.
 

.envoy.api.v2.route.RateLimit.Action.RequestHeaders request_headers = 3;

Specified by:

getRequestHeaders in interface RateLimit.ActionOrBuilder

Returns:

The requestHeaders.

getRequestHeadersOrBuilder

public RateLimit.Action.RequestHeadersOrBuilder getRequestHeadersOrBuilder()

 Rate limit on request headers.
 

.envoy.api.v2.route.RateLimit.Action.RequestHeaders request_headers = 3;

Specified by:

getRequestHeadersOrBuilder in interface RateLimit.ActionOrBuilder

hasRemoteAddress

public boolean hasRemoteAddress()

 Rate limit on remote address.
 

.envoy.api.v2.route.RateLimit.Action.RemoteAddress remote_address = 4;

Specified by:

hasRemoteAddress in interface RateLimit.ActionOrBuilder

Returns:

Whether the remoteAddress field is set.

getRemoteAddress

public RateLimit.Action.RemoteAddress getRemoteAddress()

 Rate limit on remote address.
 

.envoy.api.v2.route.RateLimit.Action.RemoteAddress remote_address = 4;

Specified by:

getRemoteAddress in interface RateLimit.ActionOrBuilder

Returns:

The remoteAddress.

getRemoteAddressOrBuilder

public RateLimit.Action.RemoteAddressOrBuilder getRemoteAddressOrBuilder()

 Rate limit on remote address.
 

.envoy.api.v2.route.RateLimit.Action.RemoteAddress remote_address = 4;

Specified by:

getRemoteAddressOrBuilder in interface RateLimit.ActionOrBuilder

hasGenericKey

public boolean hasGenericKey()

 Rate limit on a generic key.
 

.envoy.api.v2.route.RateLimit.Action.GenericKey generic_key = 5;

Specified by:

hasGenericKey in interface RateLimit.ActionOrBuilder

Returns:

Whether the genericKey field is set.

getGenericKey

public RateLimit.Action.GenericKey getGenericKey()

 Rate limit on a generic key.
 

.envoy.api.v2.route.RateLimit.Action.GenericKey generic_key = 5;

Specified by:

getGenericKey in interface RateLimit.ActionOrBuilder

Returns:

The genericKey.

getGenericKeyOrBuilder

public RateLimit.Action.GenericKeyOrBuilder getGenericKeyOrBuilder()

 Rate limit on a generic key.
 

.envoy.api.v2.route.RateLimit.Action.GenericKey generic_key = 5;

Specified by:

getGenericKeyOrBuilder in interface RateLimit.ActionOrBuilder

hasHeaderValueMatch

public boolean hasHeaderValueMatch()

 Rate limit on the existence of request headers.
 

.envoy.api.v2.route.RateLimit.Action.HeaderValueMatch header_value_match = 6;

Specified by:

hasHeaderValueMatch in interface RateLimit.ActionOrBuilder

Returns:

Whether the headerValueMatch field is set.

getHeaderValueMatch

public RateLimit.Action.HeaderValueMatch getHeaderValueMatch()

 Rate limit on the existence of request headers.
 

.envoy.api.v2.route.RateLimit.Action.HeaderValueMatch header_value_match = 6;

Specified by:

getHeaderValueMatch in interface RateLimit.ActionOrBuilder

Returns:

The headerValueMatch.

getHeaderValueMatchOrBuilder

public RateLimit.Action.HeaderValueMatchOrBuilder getHeaderValueMatchOrBuilder()

 Rate limit on the existence of request headers.
 

.envoy.api.v2.route.RateLimit.Action.HeaderValueMatch header_value_match = 6;

Specified by:

getHeaderValueMatchOrBuilder in interface RateLimit.ActionOrBuilder

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 RateLimit.Action parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RateLimit.Action.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RateLimit.Action.Builder newBuilder()

newBuilder

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

toBuilder

public RateLimit.Action.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RateLimit.Action getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<RateLimit.Action> 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 RateLimit.Action getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder