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

Class RateLimit.Action.MetaData.Builder

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

    • Field Detail

      • bitField0_

        private int bitField0_

      • descriptorKey_

        private java.lang.Object descriptorKey_

      • defaultValue_

        private java.lang.Object defaultValue_

      • source_

        private int source_

      • skipIfAbsent_

        private boolean skipIfAbsent_

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

      • getDefaultInstanceForType

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

      • build

        public RateLimit.Action.MetaData 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.MetaData 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.MetaData.Builder>

      • mergeFrom

        public RateLimit.Action.MetaData.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.MetaData.Builder>
        Throws:
        java.io.IOException

      • getDescriptorKey

        public java.lang.String getDescriptorKey()
         The key to use in the descriptor entry.
        string descriptor_key = 1 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorKey in interface RateLimit.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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The bytes for descriptorKey.

      • setDescriptorKey

        public RateLimit.Action.MetaData.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.MetaData.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.MetaData.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 metadata is of type string.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }
        Specified by:
        hasMetadataKey in interface RateLimit.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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The metadataKey.

      • setMetadataKey

        public RateLimit.Action.MetaData.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 metadata is of type string.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }

      • setMetadataKey

        public RateLimit.Action.MetaData.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 metadata is of type string.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }

      • mergeMetadataKey

        public RateLimit.Action.MetaData.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 metadata is of type string.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }

      • clearMetadataKey

        public RateLimit.Action.MetaData.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 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 metadata is of type string.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 2 [(.validate.rules) = { ... }

      • 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 interface RateLimit.Action.MetaDataOrBuilder

      • 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 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 ``skip_if_absent`` is followed to
 skip calling the rate limiting service or skip the descriptor.
        string default_value = 3;
        Specified by:
        getDefaultValue in interface RateLimit.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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The bytes for defaultValue.

      • setDefaultValue

        public RateLimit.Action.MetaData.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 ``skip_if_absent`` is followed to
 skip calling the rate limiting service or skip the descriptor.
        string default_value = 3;
        Parameters:
        value - The defaultValue to set.
        Returns:
        This builder for chaining.

      • clearDefaultValue

        public RateLimit.Action.MetaData.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 ``skip_if_absent`` is followed to
 skip calling the rate limiting service or skip the descriptor.
        string default_value = 3;
        Returns:
        This builder for chaining.

      • setDefaultValueBytes

        public RateLimit.Action.MetaData.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 ``skip_if_absent`` is followed to
 skip calling the rate limiting service or skip the descriptor.
        string default_value = 3;
        Parameters:
        value - The bytes for defaultValue to set.
        Returns:
        This builder for chaining.

      • getSourceValue

        public int getSourceValue()
         Source of metadata
        .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
        Specified by:
        getSourceValue in interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The enum numeric value on the wire for source.

      • setSourceValue

        public RateLimit.Action.MetaData.Builder setSourceValue​(int value)
         Source of metadata
        .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
        Parameters:
        value - The enum numeric value on the wire for source to set.
        Returns:
        This builder for chaining.

      • clearSource

        public RateLimit.Action.MetaData.Builder clearSource()
         Source of metadata
        .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • 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 interface RateLimit.Action.MetaDataOrBuilder
        Returns:
        The skipIfAbsent.

      • setSkipIfAbsent

        public RateLimit.Action.MetaData.Builder setSkipIfAbsent​(boolean value)
         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;
        Parameters:
        value - The skipIfAbsent to set.
        Returns:
        This builder for chaining.

      • clearSkipIfAbsent

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