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

Class RateLimit.HitsAddend.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.HitsAddend.Builder>
io.envoyproxy.envoy.config.route.v3.RateLimit.HitsAddend.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.HitsAddendOrBuilder, Cloneable
Enclosing class:
RateLimit.HitsAddend
public static final class RateLimit.HitsAddend.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.HitsAddend.Builder> implements RateLimit.HitsAddendOrBuilder
Protobuf type envoy.config.route.v3.RateLimit.HitsAddend

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public RateLimit.HitsAddend.Builder mergeFrom(RateLimit.HitsAddend 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.HitsAddend.Builder>

    • mergeFrom

      public RateLimit.HitsAddend.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.HitsAddend.Builder>
      Throws:
      IOException

    • hasNumber

      public boolean hasNumber()
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }
      Specified by:
      hasNumber in interface RateLimit.HitsAddendOrBuilder
      Returns:
      Whether the number field is set.

    • getNumber

      public com.google.protobuf.UInt64Value getNumber()
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }
      Specified by:
      getNumber in interface RateLimit.HitsAddendOrBuilder
      Returns:
      The number.

    • setNumber

      public RateLimit.HitsAddend.Builder setNumber(com.google.protobuf.UInt64Value value)
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }

    • setNumber

      public RateLimit.HitsAddend.Builder setNumber(com.google.protobuf.UInt64Value.Builder builderForValue)
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }

    • mergeNumber

      public RateLimit.HitsAddend.Builder mergeNumber(com.google.protobuf.UInt64Value value)
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }

    • clearNumber

      public RateLimit.HitsAddend.Builder clearNumber()
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }

    • getNumberBuilder

      public com.google.protobuf.UInt64Value.Builder getNumberBuilder()
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }

    • getNumberOrBuilder

      public com.google.protobuf.UInt64ValueOrBuilder getNumberOrBuilder()
       Fixed number of hits to add to the rate limit descriptor.

 One of the ``number`` or ``format`` fields should be set but not both.
      .google.protobuf.UInt64Value number = 1 [(.validate.rules) = { ... }
      Specified by:
      getNumberOrBuilder in interface RateLimit.HitsAddendOrBuilder

    • getFormat

      public String getFormat()
       Substitution format string to extract the number of hits to add to the rate limit descriptor.
 The same :ref:`format specifier <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` applies here.

 .. note::

   The format string must contains only single valid substitution field. If the format string
   not meets the requirement, the configuration will be rejected.

   The substitution field should generates a non-negative number or string representation of
   a non-negative number. The value of the non-negative number should be less than or equal
   to 1000000000 like the ``number`` field. If the output of the substitution field not meet
   the requirement, this will be treated as an error and the current descriptor will be ignored.

 For example, the ``%BYTES_RECEIVED%`` format string will be replaced with the number of bytes
 received in the request.

 One of the ``number`` or ``format`` fields should be set but not both.
      string format = 2 [(.validate.rules) = { ... }
      Specified by:
      getFormat in interface RateLimit.HitsAddendOrBuilder
      Returns:
      The format.

    • getFormatBytes

      public com.google.protobuf.ByteString getFormatBytes()
       Substitution format string to extract the number of hits to add to the rate limit descriptor.
 The same :ref:`format specifier <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` applies here.

 .. note::

   The format string must contains only single valid substitution field. If the format string
   not meets the requirement, the configuration will be rejected.

   The substitution field should generates a non-negative number or string representation of
   a non-negative number. The value of the non-negative number should be less than or equal
   to 1000000000 like the ``number`` field. If the output of the substitution field not meet
   the requirement, this will be treated as an error and the current descriptor will be ignored.

 For example, the ``%BYTES_RECEIVED%`` format string will be replaced with the number of bytes
 received in the request.

 One of the ``number`` or ``format`` fields should be set but not both.
      string format = 2 [(.validate.rules) = { ... }
      Specified by:
      getFormatBytes in interface RateLimit.HitsAddendOrBuilder
      Returns:
      The bytes for format.

    • setFormat

      public RateLimit.HitsAddend.Builder setFormat(String value)
       Substitution format string to extract the number of hits to add to the rate limit descriptor.
 The same :ref:`format specifier <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` applies here.

 .. note::

   The format string must contains only single valid substitution field. If the format string
   not meets the requirement, the configuration will be rejected.

   The substitution field should generates a non-negative number or string representation of
   a non-negative number. The value of the non-negative number should be less than or equal
   to 1000000000 like the ``number`` field. If the output of the substitution field not meet
   the requirement, this will be treated as an error and the current descriptor will be ignored.

 For example, the ``%BYTES_RECEIVED%`` format string will be replaced with the number of bytes
 received in the request.

 One of the ``number`` or ``format`` fields should be set but not both.
      string format = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The format to set.
      Returns:
      This builder for chaining.

    • clearFormat

      public RateLimit.HitsAddend.Builder clearFormat()
       Substitution format string to extract the number of hits to add to the rate limit descriptor.
 The same :ref:`format specifier <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` applies here.

 .. note::

   The format string must contains only single valid substitution field. If the format string
   not meets the requirement, the configuration will be rejected.

   The substitution field should generates a non-negative number or string representation of
   a non-negative number. The value of the non-negative number should be less than or equal
   to 1000000000 like the ``number`` field. If the output of the substitution field not meet
   the requirement, this will be treated as an error and the current descriptor will be ignored.

 For example, the ``%BYTES_RECEIVED%`` format string will be replaced with the number of bytes
 received in the request.

 One of the ``number`` or ``format`` fields should be set but not both.
      string format = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setFormatBytes

      public RateLimit.HitsAddend.Builder setFormatBytes(com.google.protobuf.ByteString value)
       Substitution format string to extract the number of hits to add to the rate limit descriptor.
 The same :ref:`format specifier <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` applies here.

 .. note::

   The format string must contains only single valid substitution field. If the format string
   not meets the requirement, the configuration will be rejected.

   The substitution field should generates a non-negative number or string representation of
   a non-negative number. The value of the non-negative number should be less than or equal
   to 1000000000 like the ``number`` field. If the output of the substitution field not meet
   the requirement, this will be treated as an error and the current descriptor will be ignored.

 For example, the ``%BYTES_RECEIVED%`` format string will be replaced with the number of bytes
 received in the request.

 One of the ``number`` or ``format`` fields should be set but not both.
      string format = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for format to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final RateLimit.HitsAddend.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.HitsAddend.Builder>

    • mergeUnknownFields

      public final RateLimit.HitsAddend.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.HitsAddend.Builder>