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
,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 type
envoy.config.route.v3.RateLimit.Action.MetaData
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
The following descriptor entry is appended when the metadata contains a key value: ..static enum
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>, 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 int
private static final RateLimit.Action.MetaData
static final int
private Object
static final int
private Object
private byte
static final int
private MetadataKey
private static final com.google.protobuf.Parser
<RateLimit.Action.MetaData> private static final long
static final int
private boolean
private int
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
static RateLimit.Action.MetaData
An optional value to use if ``metadata_key`` is empty.com.google.protobuf.ByteString
An optional value to use if ``metadata_key`` is empty.static final com.google.protobuf.Descriptors.Descriptor
The key to use in the descriptor entry.com.google.protobuf.ByteString
The key to use in the descriptor entry.Metadata struct that defines the key and path to retrieve the string value.Metadata struct that defines the key and path to retrieve the string value.com.google.protobuf.Parser
<RateLimit.Action.MetaData> int
boolean
If set to true, Envoy skips the descriptor while calling rate limiting service when ``metadata_key`` is empty and ``default_value`` is not set.Source of metadataint
Source of metadataint
hashCode()
boolean
Metadata struct that defines the key and path to retrieve the string value.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilder
(RateLimit.Action.MetaData prototype) protected RateLimit.Action.MetaData.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static RateLimit.Action.MetaData
parseDelimitedFrom
(InputStream input) static RateLimit.Action.MetaData
parseDelimitedFrom
(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
(InputStream input) static RateLimit.Action.MetaData
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimit.Action.MetaData
parseFrom
(ByteBuffer data) static RateLimit.Action.MetaData
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<RateLimit.Action.MetaData> 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_ -
DESCRIPTOR_KEY_FIELD_NUMBER
public static final int DESCRIPTOR_KEY_FIELD_NUMBER- See Also:
-
descriptorKey_
-
METADATA_KEY_FIELD_NUMBER
public static final int METADATA_KEY_FIELD_NUMBER- See Also:
-
metadataKey_
-
DEFAULT_VALUE_FIELD_NUMBER
public static final int DEFAULT_VALUE_FIELD_NUMBER- See Also:
-
defaultValue_
-
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER- See Also:
-
source_
private int source_ -
SKIP_IF_ABSENT_FIELD_NUMBER
public static final int SKIP_IF_ABSENT_FIELD_NUMBER- See Also:
-
skipIfAbsent_
private boolean skipIfAbsent_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
MetaData
private MetaData(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
MetaData
private MetaData()
-
-
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
-
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
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
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
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
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
- 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.Action.MetaData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(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
- Throws:
IOException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static RateLimit.Action.MetaData parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimit.Action.MetaData parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimit.Action.MetaData 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.Action.MetaData.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
-