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

Interface RateLimit.HitsAddendOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimit.HitsAddend, RateLimit.HitsAddend.Builder
Enclosing class:
RateLimit
public static interface RateLimit.HitsAddendOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFormat()
    Substitution format string to extract the number of hits to add to the rate limit descriptor.
    com.google.protobuf.ByteString
    getFormatBytes()
    Substitution format string to extract the number of hits to add to the rate limit descriptor.
    com.google.protobuf.UInt64Value
    getNumber()
    Fixed number of hits to add to the rate limit descriptor.
    com.google.protobuf.UInt64ValueOrBuilder
    getNumberOrBuilder()
    Fixed number of hits to add to the rate limit descriptor.
    boolean
    hasNumber()
    Fixed number of hits to add to the rate limit descriptor.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasNumber

      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) = { ... }
      Returns:
      Whether the number field is set.

    • getNumber

      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) = { ... }
      Returns:
      The number.

    • getNumberOrBuilder

      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) = { ... }

    • getFormat

      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) = { ... }
      Returns:
      The format.

    • getFormatBytes

      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) = { ... }
      Returns:
      The bytes for format.