Package io.envoyproxy.envoy.extensions.common.ratelimit.v3

Class LocalRateLimitDescriptor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalRateLimitDescriptorOrBuilder, Serializable
public final class LocalRateLimitDescriptor extends com.google.protobuf.GeneratedMessageV3 implements LocalRateLimitDescriptorOrBuilder
 Configuration used to enable local rate limiting.

 .. note::
   The ``LocalRateLimitDescriptor`` is used to configure a local rate limit rule with a token
   bucket algorithm. The ``RateLimitDescriptor`` is used to represent a list of symbols that
   are used to match against the rate limit rule.
Protobuf type envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor
See Also:

  • Field Details

    • ENTRIES_FIELD_NUMBER

      public static final int ENTRIES_FIELD_NUMBER
      See Also:

    • TOKEN_BUCKET_FIELD_NUMBER

      public static final int TOKEN_BUCKET_FIELD_NUMBER
      See Also:

  • 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

    • getEntriesList

      public List<RateLimitDescriptor.Entry> getEntriesList()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesList in interface LocalRateLimitDescriptorOrBuilder

    • getEntriesOrBuilderList

      public List<? extends RateLimitDescriptor.EntryOrBuilder> getEntriesOrBuilderList()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesOrBuilderList in interface LocalRateLimitDescriptorOrBuilder

    • getEntriesCount

      public int getEntriesCount()
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesCount in interface LocalRateLimitDescriptorOrBuilder

    • getEntries

      public RateLimitDescriptor.Entry getEntries(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntries in interface LocalRateLimitDescriptorOrBuilder

    • getEntriesOrBuilder

      public RateLimitDescriptor.EntryOrBuilder getEntriesOrBuilder(int index)
       Descriptor entries.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }
      Specified by:
      getEntriesOrBuilder in interface LocalRateLimitDescriptorOrBuilder

    • hasTokenBucket

      public boolean hasTokenBucket()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      hasTokenBucket in interface LocalRateLimitDescriptorOrBuilder
      Returns:
      Whether the tokenBucket field is set.

    • getTokenBucket

      public TokenBucket getTokenBucket()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenBucket in interface LocalRateLimitDescriptorOrBuilder
      Returns:
      The tokenBucket.

    • getTokenBucketOrBuilder

      public TokenBucketOrBuilder getTokenBucketOrBuilder()
       Token Bucket algorithm for local ratelimiting.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenBucketOrBuilder in interface LocalRateLimitDescriptorOrBuilder

    • 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 LocalRateLimitDescriptor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static LocalRateLimitDescriptor parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static LocalRateLimitDescriptor parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LocalRateLimitDescriptor.Builder newBuilder()

    • newBuilder

      public static LocalRateLimitDescriptor.Builder newBuilder(LocalRateLimitDescriptor prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LocalRateLimitDescriptor getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<LocalRateLimitDescriptor> 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 LocalRateLimitDescriptor getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder