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

Class RateLimit.HitsAddend

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RateLimit.HitsAddend.Builder
    Protobuf type envoy.config.route.v3.RateLimit.HitsAddend

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FORMAT_FIELD_NUMBER
     
    static final int
    NUMBER_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RateLimit.HitsAddend
    getDefaultInstance()
     
    RateLimit.HitsAddend
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<RateLimit.HitsAddend>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasNumber()
    Fixed number of hits to add to the rate limit descriptor.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RateLimit.HitsAddend.Builder
    newBuilder()
     
    static RateLimit.HitsAddend.Builder
    newBuilder(RateLimit.HitsAddend prototype)
     
    RateLimit.HitsAddend.Builder
    newBuilderForType()
     
    protected RateLimit.HitsAddend.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RateLimit.HitsAddend
    parseDelimitedFrom(InputStream input)
     
    static RateLimit.HitsAddend
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit.HitsAddend
    parseFrom(byte[] data)
     
    static RateLimit.HitsAddend
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit.HitsAddend
    parseFrom(com.google.protobuf.ByteString data)
     
    static RateLimit.HitsAddend
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit.HitsAddend
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RateLimit.HitsAddend
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit.HitsAddend
    parseFrom(InputStream input)
     
    static RateLimit.HitsAddend
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit.HitsAddend
    parseFrom(ByteBuffer data)
     
    static RateLimit.HitsAddend
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RateLimit.HitsAddend>
    parser()
     
    RateLimit.HitsAddend.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

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

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RateLimit.HitsAddend parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RateLimit.HitsAddend parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimit.HitsAddend parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static RateLimit.HitsAddend.Builder newBuilder()

    • newBuilder

      public static RateLimit.HitsAddend.Builder newBuilder(RateLimit.HitsAddend prototype)

    • toBuilder

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

    • newBuilderForType

      protected RateLimit.HitsAddend.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RateLimit.HitsAddend getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RateLimit.HitsAddend> parser()

    • getParserForType

      public com.google.protobuf.Parser<RateLimit.HitsAddend> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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