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, java.lang.Cloneable
    Enclosing class:
    RateLimit.Action.DynamicMetaData

    public static final class RateLimit.Action.DynamicMetaData.Builder
    extends com.google.protobuf.GeneratedMessage.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
    • Field Detail

      • bitField0_

        private int bitField0_
      • descriptorKey_

        private java.lang.Object descriptorKey_
      • defaultValue_

        private java.lang.Object defaultValue_
    • Constructor Detail

      • Builder

        private Builder()
      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RateLimit.Action.DynamicMetaData.Builder>
      • maybeForceBuilderInitialization

        private void maybeForceBuilderInitialization()
      • 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.GeneratedMessage.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.GeneratedMessage.Builder<RateLimit.Action.DynamicMetaData.Builder>
      • mergeFrom

        public RateLimit.Action.DynamicMetaData.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.DynamicMetaData.Builder>
        Throws:
        java.io.IOException
      • 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​(java.lang.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) = { ... }
      • getMetadataKeyFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<MetadataKey,​MetadataKey.Builder,​MetadataKeyOrBuilder> getMetadataKeyFieldBuilder()
         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 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 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​(java.lang.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.