Package io.envoyproxy.envoy.config.route.v3

Class RateLimit.Action.DynamicMetaData.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.DynamicMetaDataOrBuilder, Cloneable
    Enclosing class:
    RateLimit.Action.DynamicMetaData
    public static final class RateLimit.Action.DynamicMetaData.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.DynamicMetaData.Builder>
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

    • Method Detail

      • 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.Builder<RateLimit.Action.DynamicMetaData.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.DynamicMetaData.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.DynamicMetaData.Builder>

      • 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.

      • setDescriptorKey

        public RateLimit.Action.DynamicMetaData.Builder setDescriptorKey​(String value)
         The key to use in the descriptor entry.
        string descriptor_key = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The descriptorKey to set.
        Returns:
        This builder for chaining.

      • clearDescriptorKey

        public RateLimit.Action.DynamicMetaData.Builder clearDescriptorKey()
         The key to use in the descriptor entry.
        string descriptor_key = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setDescriptorKeyBytes

        public RateLimit.Action.DynamicMetaData.Builder setDescriptorKeyBytes​(com.google.protobuf.ByteString value)
         The key to use in the descriptor entry.
        string descriptor_key = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for descriptorKey to set.
        Returns:
        This builder for chaining.

      • 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.

      • setMetadataKey

        public RateLimit.Action.DynamicMetaData.Builder setMetadataKey​(MetadataKey value)
         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) = { ... }

      • setMetadataKey

        public RateLimit.Action.DynamicMetaData.Builder setMetadataKey​(MetadataKey.Builder builderForValue)
         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) = { ... }

      • mergeMetadataKey

        public RateLimit.Action.DynamicMetaData.Builder mergeMetadataKey​(MetadataKey value)
         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) = { ... }

      • clearMetadataKey

        public RateLimit.Action.DynamicMetaData.Builder clearMetadataKey()
         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) = { ... }

      • getMetadataKeyBuilder

        public MetadataKey.Builder getMetadataKeyBuilder()
         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) = { ... }

      • 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.

      • setDefaultValue

        public RateLimit.Action.DynamicMetaData.Builder setDefaultValue​(String value)
         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;
        Parameters:
        value - The defaultValue to set.
        Returns:
        This builder for chaining.

      • clearDefaultValue

        public RateLimit.Action.DynamicMetaData.Builder clearDefaultValue()
         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;
        Returns:
        This builder for chaining.

      • setDefaultValueBytes

        public RateLimit.Action.DynamicMetaData.Builder setDefaultValueBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for defaultValue to set.
        Returns:
        This builder for chaining.