Class RateLimit.Action.DynamicMetaData

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.RateLimit.Action.DynamicMetaData
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.DynamicMetaDataOrBuilder, Serializable
Enclosing class:
RateLimit.Action
public static final class RateLimit.Action.DynamicMetaData extends com.google.protobuf.GeneratedMessage implements RateLimit.Action.DynamicMetaDataOrBuilder
The following descriptor entry is appended when the
:ref:`dynamic metadata <well_known_dynamic_metadata>` contains a key value:

.. code-block:: cpp

("<descriptor_key>", "<value_queried_from_dynamic_metadata>")

.. attention::
This action has been deprecated in favor of the :ref:`metadata <envoy_v3_api_msg_config.route.v3.RateLimit.Action.MetaData>` action
Protobuf type envoy.config.route.v3.RateLimit.Action.DynamicMetaData
See Also:

  • Field Details

    • DESCRIPTOR_KEY_FIELD_NUMBER

      public static final int DESCRIPTOR_KEY_FIELD_NUMBER
      See Also:

    • METADATA_KEY_FIELD_NUMBER

      public static final int METADATA_KEY_FIELD_NUMBER
      See Also:

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDescriptorKey

      public String getDescriptorKey()
      The key to use in the descriptor entry.
      string descriptor_key = 1 [(.validate.rules) = { ... }
      Specified by:
      getDescriptorKey in interface RateLimit.Action.DynamicMetaDataOrBuilder
      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 interface RateLimit.Action.DynamicMetaDataOrBuilder
      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 dynamic metadata is of type string.
      .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
      Specified by:
      hasMetadataKey in interface RateLimit.Action.DynamicMetaDataOrBuilder
      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 dynamic metadata is of type string.
      .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
      Specified by:
      getMetadataKey in interface RateLimit.Action.DynamicMetaDataOrBuilder
      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 dynamic metadata is of type string.
      .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
      Specified by:
      getMetadataKeyOrBuilder in interface RateLimit.Action.DynamicMetaDataOrBuilder

    • getDefaultValue

      public 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 no descriptor is generated.
      string default_value = 3;
      Specified by:
      getDefaultValue in interface RateLimit.Action.DynamicMetaDataOrBuilder
      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 no descriptor is generated.
      string default_value = 3;
      Specified by:
      getDefaultValueBytes in interface RateLimit.Action.DynamicMetaDataOrBuilder
      Returns:
      The bytes for defaultValue.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.DynamicMetaData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

      public RateLimit.Action.DynamicMetaData.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.DynamicMetaData.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public RateLimit.Action.DynamicMetaData.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RateLimit.Action.DynamicMetaData.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RateLimit.Action.DynamicMetaData getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RateLimit.Action.DynamicMetaData> 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.GeneratedMessage

    • getDefaultInstanceForType

      public RateLimit.Action.DynamicMetaData getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder