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

Class RateLimit.Action.MetaData.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>
io.envoyproxy.envoy.config.route.v3.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, Cloneable
Enclosing class:
RateLimit.Action.MetaData
public static final class RateLimit.Action.MetaData.Builder extends com.google.protobuf.GeneratedMessageV3.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

  • Method Details

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

    • clear

      public RateLimit.Action.MetaData.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.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.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

    • clone

      public RateLimit.Action.MetaData.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • setField

      public RateLimit.Action.MetaData.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • clearField

      public RateLimit.Action.MetaData.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • clearOneof

      public RateLimit.Action.MetaData.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • setRepeatedField

      public RateLimit.Action.MetaData.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • addRepeatedField

      public RateLimit.Action.MetaData.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • mergeFrom

      public RateLimit.Action.MetaData.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.MetaData.Builder>

    • mergeFrom

      public RateLimit.Action.MetaData.Builder mergeFrom(RateLimit.Action.MetaData other)

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

    • mergeFrom

      public RateLimit.Action.MetaData.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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:
      IOException

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

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

    • getSource

      public RateLimit.Action.MetaData.Source getSource()
       Source of metadata
      .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
      Specified by:
      getSource in interface RateLimit.Action.MetaDataOrBuilder
      Returns:
      The source.

    • setSource

      public RateLimit.Action.MetaData.Builder setSource(RateLimit.Action.MetaData.Source value)
       Source of metadata
      .envoy.config.route.v3.RateLimit.Action.MetaData.Source source = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The 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()
       Controls the behavior when the specified ``metadata_key`` is empty and ``default_value`` is not set.

 If set to ``false`` (default):

 * Envoy does **NOT** call the rate limiting service for this descriptor.
 * Useful if the metadata is optional and you prefer to skip rate limiting when it's absent.

 If set to ``true``:

 * Envoy calls the rate limiting service but omits this descriptor if the ``metadata_key`` is empty and
   ``default_value`` is missing.
 * Useful if you want Envoy to enforce rate limiting even when the metadata is not present.
      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)
       Controls the behavior when the specified ``metadata_key`` is empty and ``default_value`` is not set.

 If set to ``false`` (default):

 * Envoy does **NOT** call the rate limiting service for this descriptor.
 * Useful if the metadata is optional and you prefer to skip rate limiting when it's absent.

 If set to ``true``:

 * Envoy calls the rate limiting service but omits this descriptor if the ``metadata_key`` is empty and
   ``default_value`` is missing.
 * Useful if you want Envoy to enforce rate limiting even when the metadata is not present.
      bool skip_if_absent = 5;
      Parameters:
      value - The skipIfAbsent to set.
      Returns:
      This builder for chaining.

    • clearSkipIfAbsent

      public RateLimit.Action.MetaData.Builder clearSkipIfAbsent()
       Controls the behavior when the specified ``metadata_key`` is empty and ``default_value`` is not set.

 If set to ``false`` (default):

 * Envoy does **NOT** call the rate limiting service for this descriptor.
 * Useful if the metadata is optional and you prefer to skip rate limiting when it's absent.

 If set to ``true``:

 * Envoy calls the rate limiting service but omits this descriptor if the ``metadata_key`` is empty and
   ``default_value`` is missing.
 * Useful if you want Envoy to enforce rate limiting even when the metadata is not present.
      bool skip_if_absent = 5;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final RateLimit.Action.MetaData.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>

    • mergeUnknownFields

      public final RateLimit.Action.MetaData.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.MetaData.Builder>