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 typeenvoy.api.v2.route.RateLimit.Action- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRateLimit.Action.ActionSpecifierCasestatic classRateLimit.Action.Builder[#next-free-field: 7]static classRateLimit.Action.DestinationClusterThe 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 tostatic interfaceRateLimit.Action.DestinationClusterOrBuilderstatic classRateLimit.Action.GenericKeyThe following descriptor entry is appended to the descriptor: .. code-block:: cpp ("generic_key", "<descriptor_value>")static interfaceRateLimit.Action.GenericKeyOrBuilderstatic classRateLimit.Action.HeaderValueMatchThe following descriptor entry is appended to the descriptor: .. code-block:: cpp ("header_match", "<descriptor_value>")static interfaceRateLimit.Action.HeaderValueMatchOrBuilderstatic classRateLimit.Action.RemoteAddressThe 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 interfaceRateLimit.Action.RemoteAddressOrBuilderstatic classRateLimit.Action.RequestHeadersThe 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 interfaceRateLimit.Action.RequestHeadersOrBuilderstatic classRateLimit.Action.SourceClusterThe 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 interfaceRateLimit.Action.SourceClusterOrBuilder-
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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intDESTINATION_CLUSTER_FIELD_NUMBERstatic intGENERIC_KEY_FIELD_NUMBERstatic intHEADER_VALUE_MATCH_FIELD_NUMBERstatic intREMOTE_ADDRESS_FIELD_NUMBERstatic intREQUEST_HEADERS_FIELD_NUMBERstatic intSOURCE_CLUSTER_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)RateLimit.Action.ActionSpecifierCasegetActionSpecifierCase()static RateLimit.ActiongetDefaultInstance()RateLimit.ActiongetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()RateLimit.Action.DestinationClustergetDestinationCluster()Rate limit on destination cluster.RateLimit.Action.DestinationClusterOrBuildergetDestinationClusterOrBuilder()Rate limit on destination cluster.RateLimit.Action.GenericKeygetGenericKey()Rate limit on a generic key.RateLimit.Action.GenericKeyOrBuildergetGenericKeyOrBuilder()Rate limit on a generic key.RateLimit.Action.HeaderValueMatchgetHeaderValueMatch()Rate limit on the existence of request headers.RateLimit.Action.HeaderValueMatchOrBuildergetHeaderValueMatchOrBuilder()Rate limit on the existence of request headers.com.google.protobuf.Parser<RateLimit.Action>getParserForType()RateLimit.Action.RemoteAddressgetRemoteAddress()Rate limit on remote address.RateLimit.Action.RemoteAddressOrBuildergetRemoteAddressOrBuilder()Rate limit on remote address.RateLimit.Action.RequestHeadersgetRequestHeaders()Rate limit on request headers.RateLimit.Action.RequestHeadersOrBuildergetRequestHeadersOrBuilder()Rate limit on request headers.intgetSerializedSize()RateLimit.Action.SourceClustergetSourceCluster()Rate limit on source cluster.RateLimit.Action.SourceClusterOrBuildergetSourceClusterOrBuilder()Rate limit on source cluster.com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasDestinationCluster()Rate limit on destination cluster.booleanhasGenericKey()Rate limit on a generic key.inthashCode()booleanhasHeaderValueMatch()Rate limit on the existence of request headers.booleanhasRemoteAddress()Rate limit on remote address.booleanhasRequestHeaders()Rate limit on request headers.booleanhasSourceCluster()Rate limit on source cluster.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static RateLimit.Action.BuildernewBuilder()static RateLimit.Action.BuildernewBuilder(RateLimit.Action prototype)RateLimit.Action.BuildernewBuilderForType()protected RateLimit.Action.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static RateLimit.ActionparseDelimitedFrom(InputStream input)static RateLimit.ActionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RateLimit.ActionparseFrom(byte[] data)static RateLimit.ActionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RateLimit.ActionparseFrom(com.google.protobuf.ByteString data)static RateLimit.ActionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RateLimit.ActionparseFrom(com.google.protobuf.CodedInputStream input)static RateLimit.ActionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RateLimit.ActionparseFrom(InputStream input)static RateLimit.ActionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RateLimit.ActionparseFrom(ByteBuffer data)static RateLimit.ActionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<RateLimit.Action>parser()RateLimit.Action.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, 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, 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
-
-
-
-
Field Detail
-
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 Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getActionSpecifierCase
public RateLimit.Action.ActionSpecifierCase getActionSpecifierCase()
- Specified by:
getActionSpecifierCasein interfaceRateLimit.ActionOrBuilder
-
hasSourceCluster
public boolean hasSourceCluster()
Rate limit on source cluster.
.envoy.api.v2.route.RateLimit.Action.SourceCluster source_cluster = 1;- Specified by:
hasSourceClusterin interfaceRateLimit.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:
getSourceClusterin interfaceRateLimit.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:
getSourceClusterOrBuilderin interfaceRateLimit.ActionOrBuilder
-
hasDestinationCluster
public boolean hasDestinationCluster()
Rate limit on destination cluster.
.envoy.api.v2.route.RateLimit.Action.DestinationCluster destination_cluster = 2;- Specified by:
hasDestinationClusterin interfaceRateLimit.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:
getDestinationClusterin interfaceRateLimit.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:
getDestinationClusterOrBuilderin interfaceRateLimit.ActionOrBuilder
-
hasRequestHeaders
public boolean hasRequestHeaders()
Rate limit on request headers.
.envoy.api.v2.route.RateLimit.Action.RequestHeaders request_headers = 3;- Specified by:
hasRequestHeadersin interfaceRateLimit.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:
getRequestHeadersin interfaceRateLimit.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:
getRequestHeadersOrBuilderin interfaceRateLimit.ActionOrBuilder
-
hasRemoteAddress
public boolean hasRemoteAddress()
Rate limit on remote address.
.envoy.api.v2.route.RateLimit.Action.RemoteAddress remote_address = 4;- Specified by:
hasRemoteAddressin interfaceRateLimit.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:
getRemoteAddressin interfaceRateLimit.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:
getRemoteAddressOrBuilderin interfaceRateLimit.ActionOrBuilder
-
hasGenericKey
public boolean hasGenericKey()
Rate limit on a generic key.
.envoy.api.v2.route.RateLimit.Action.GenericKey generic_key = 5;- Specified by:
hasGenericKeyin interfaceRateLimit.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:
getGenericKeyin interfaceRateLimit.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:
getGenericKeyOrBuilderin interfaceRateLimit.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:
hasHeaderValueMatchin interfaceRateLimit.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:
getHeaderValueMatchin interfaceRateLimit.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:
getHeaderValueMatchOrBuilderin interfaceRateLimit.ActionOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimit.Action.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public RateLimit.Action getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-