Class RateLimit.Action.MetaData
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.route.v3.RateLimit.Action.MetaData
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimit.Action.MetaDataOrBuilder
,java.io.Serializable
- Enclosing class:
- RateLimit.Action
public static final class RateLimit.Action.MetaData extends com.google.protobuf.GeneratedMessage implements RateLimit.Action.MetaDataOrBuilder
The following descriptor entry is appended when the metadata contains a key value: .. code-block:: cpp ("<descriptor_key>", "<value_queried_from_metadata>") [#next-free-field: 6]
Protobuf typeenvoy.config.route.v3.RateLimit.Action.MetaData
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RateLimit.Action.MetaData.Builder
The following descriptor entry is appended when the metadata contains a key value: ..static class
RateLimit.Action.MetaData.Source
Protobuf enumenvoy.config.route.v3.RateLimit.Action.MetaData.Source
-
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private static RateLimit.Action.MetaData
DEFAULT_INSTANCE
static int
DEFAULT_VALUE_FIELD_NUMBER
private java.lang.Object
defaultValue_
static int
DESCRIPTOR_KEY_FIELD_NUMBER
private java.lang.Object
descriptorKey_
private byte
memoizedIsInitialized
static int
METADATA_KEY_FIELD_NUMBER
private MetadataKey
metadataKey_
private static com.google.protobuf.Parser<RateLimit.Action.MetaData>
PARSER
private static long
serialVersionUID
static int
SKIP_IF_ABSENT_FIELD_NUMBER
private boolean
skipIfAbsent_
private int
source_
static int
SOURCE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static RateLimit.Action.MetaData
getDefaultInstance()
RateLimit.Action.MetaData
getDefaultInstanceForType()
java.lang.String
getDefaultValue()
An optional value to use if ``metadata_key`` is empty.com.google.protobuf.ByteString
getDefaultValueBytes()
An optional value to use if ``metadata_key`` is empty.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
java.lang.String
getDescriptorKey()
The key to use in the descriptor entry.com.google.protobuf.ByteString
getDescriptorKeyBytes()
The key to use in the descriptor entry.MetadataKey
getMetadataKey()
Metadata struct that defines the key and path to retrieve the string value.MetadataKeyOrBuilder
getMetadataKeyOrBuilder()
Metadata struct that defines the key and path to retrieve the string value.com.google.protobuf.Parser<RateLimit.Action.MetaData>
getParserForType()
int
getSerializedSize()
boolean
getSkipIfAbsent()
If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set.RateLimit.Action.MetaData.Source
getSource()
Source of metadataint
getSourceValue()
Source of metadataint
hashCode()
boolean
hasMetadataKey()
Metadata struct that defines the key and path to retrieve the string value.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RateLimit.Action.MetaData.Builder
newBuilder()
static RateLimit.Action.MetaData.Builder
newBuilder(RateLimit.Action.MetaData prototype)
RateLimit.Action.MetaData.Builder
newBuilderForType()
protected RateLimit.Action.MetaData.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RateLimit.Action.MetaData
parseDelimitedFrom(java.io.InputStream input)
static RateLimit.Action.MetaData
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action.MetaData
parseFrom(byte[] data)
static RateLimit.Action.MetaData
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action.MetaData
parseFrom(com.google.protobuf.ByteString data)
static RateLimit.Action.MetaData
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action.MetaData
parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimit.Action.MetaData
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action.MetaData
parseFrom(java.io.InputStream input)
static RateLimit.Action.MetaData
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit.Action.MetaData
parseFrom(java.nio.ByteBuffer data)
static RateLimit.Action.MetaData
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimit.Action.MetaData>
parser()
RateLimit.Action.MetaData.Builder
toBuilder()
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
DESCRIPTOR_KEY_FIELD_NUMBER
public static final int DESCRIPTOR_KEY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
descriptorKey_
private volatile java.lang.Object descriptorKey_
-
METADATA_KEY_FIELD_NUMBER
public static final int METADATA_KEY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
metadataKey_
private MetadataKey metadataKey_
-
DEFAULT_VALUE_FIELD_NUMBER
public static final int DEFAULT_VALUE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
defaultValue_
private volatile java.lang.Object defaultValue_
-
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
source_
private int source_
-
SKIP_IF_ABSENT_FIELD_NUMBER
public static final int SKIP_IF_ABSENT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
skipIfAbsent_
private boolean skipIfAbsent_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final RateLimit.Action.MetaData DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<RateLimit.Action.MetaData> PARSER
-
-
Method Detail
-
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
-
getDescriptorKey
public java.lang.String getDescriptorKey()
The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Specified by:
getDescriptorKey
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The descriptorKey.
-
getDescriptorKeyBytes
public com.google.protobuf.ByteString getDescriptorKeyBytes()
The key to use in the descriptor entry.
string descriptor_key = 1 [(.validate.rules) = { ... }
- Specified by:
getDescriptorKeyBytes
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The bytes for descriptorKey.
-
hasMetadataKey
public boolean hasMetadataKey()
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
- Specified by:
hasMetadataKey
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- Whether the metadataKey field is set.
-
getMetadataKey
public MetadataKey getMetadataKey()
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
- Specified by:
getMetadataKey
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The metadataKey.
-
getMetadataKeyOrBuilder
public MetadataKeyOrBuilder getMetadataKeyOrBuilder()
Metadata struct that defines the key and path to retrieve the string value. A match will only happen if the value in the metadata is of type string.
.envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
- Specified by:
getMetadataKeyOrBuilder
in interfaceRateLimit.Action.MetaDataOrBuilder
-
getDefaultValue
public java.lang.String getDefaultValue()
An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Specified by:
getDefaultValue
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The defaultValue.
-
getDefaultValueBytes
public com.google.protobuf.ByteString getDefaultValueBytes()
An optional value to use if ``metadata_key`` is empty. If not set and no value is present under the metadata_key then ``skip_if_absent`` is followed to skip calling the rate limiting service or skip the descriptor.
string default_value = 3;
- Specified by:
getDefaultValueBytes
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The bytes for defaultValue.
-
getSourceValue
public int getSourceValue()
Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Specified by:
getSourceValue
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The enum numeric value on the wire for source.
-
getSource
public RateLimit.Action.MetaData.Source getSource()
Source of metadata
.envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
- Specified by:
getSource
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The source.
-
getSkipIfAbsent
public boolean getSkipIfAbsent()
If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set. By default it skips calling the rate limiting service in that case.
bool skip_if_absent = 5;
- Specified by:
getSkipIfAbsent
in interfaceRateLimit.Action.MetaDataOrBuilder
- Returns:
- The skipIfAbsent.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- 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.Action.MetaData parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit.Action.MetaData 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.MetaData parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RateLimit.Action.MetaData parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RateLimit.Action.MetaData parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public RateLimit.Action.MetaData.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RateLimit.Action.MetaData.Builder newBuilder()
-
newBuilder
public static RateLimit.Action.MetaData.Builder newBuilder(RateLimit.Action.MetaData prototype)
-
toBuilder
public RateLimit.Action.MetaData.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimit.Action.MetaData.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static RateLimit.Action.MetaData getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RateLimit.Action.MetaData> parser()
-
getParserForType
public com.google.protobuf.Parser<RateLimit.Action.MetaData> 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
public RateLimit.Action.MetaData getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-