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

Class RateLimitDescriptor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.ratelimit.v3.RateLimitDescriptor
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitDescriptorOrBuilder, Serializable
public final class RateLimitDescriptor extends com.google.protobuf.GeneratedMessageV3 implements RateLimitDescriptorOrBuilder
 A RateLimitDescriptor is a list of hierarchical entries that are used by the service to
 determine the final rate limit key and overall allowed limit. Here are some examples of how
 they might be used for the domain "envoy".

 .. code-block:: cpp

   ["authenticated": "false"], ["remote_address": "10.0.0.1"]

 What it does: Limits all unauthenticated traffic for the IP address 10.0.0.1. The
 configuration supplies a default limit for the *remote_address* key. If there is a desire to
 raise the limit for 10.0.0.1 or block it entirely it can be specified directly in the
 configuration.

 .. code-block:: cpp

   ["authenticated": "false"], ["path": "/foo/bar"]

 What it does: Limits all unauthenticated traffic globally for a specific path (or prefix if
 configured that way in the service).

 .. code-block:: cpp

   ["authenticated": "false"], ["path": "/foo/bar"], ["remote_address": "10.0.0.1"]

 What it does: Limits unauthenticated traffic to a specific path for a specific IP address.
 Like (1) we can raise/block specific IP addresses if we want with an override configuration.

 .. code-block:: cpp

   ["authenticated": "true"], ["client_id": "foo"]

 What it does: Limits all traffic for an authenticated client "foo"

 .. code-block:: cpp

   ["authenticated": "true"], ["client_id": "foo"], ["path": "/foo/bar"]

 What it does: Limits traffic to a specific path for an authenticated client "foo"

 The idea behind the API is that (1)/(2)/(3) and (4)/(5) can be sent in 1 request if desired.
 This enables building complex application scenarios with a generic backend.

 Optionally the descriptor can contain a limit override under a "limit" key, that specifies
 the number of requests per unit to use instead of the number configured in the
 rate limiting service.
Protobuf type envoy.extensions.common.ratelimit.v3.RateLimitDescriptor
See Also:

  • 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

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

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

    • getEntriesCount

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

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

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

    • hasLimit

      public boolean hasLimit()
       Optional rate limit override to supply to the ratelimit service.
      .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride limit = 2;
      Specified by:
      hasLimit in interface RateLimitDescriptorOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public RateLimitDescriptor.RateLimitOverride getLimit()
       Optional rate limit override to supply to the ratelimit service.
      .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride limit = 2;
      Specified by:
      getLimit in interface RateLimitDescriptorOrBuilder
      Returns:
      The limit.

    • getLimitOrBuilder

      public RateLimitDescriptor.RateLimitOverrideOrBuilder getLimitOrBuilder()
       Optional rate limit override to supply to the ratelimit service.
      .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride limit = 2;
      Specified by:
      getLimitOrBuilder in interface RateLimitDescriptorOrBuilder

    • hasHitsAddend

      public boolean hasHitsAddend()
       Optional hits_addend for the rate limit descriptor. If set the value will override the
 request level hits_addend.
      .google.protobuf.UInt64Value hits_addend = 3;
      Specified by:
      hasHitsAddend in interface RateLimitDescriptorOrBuilder
      Returns:
      Whether the hitsAddend field is set.

    • getHitsAddend

      public com.google.protobuf.UInt64Value getHitsAddend()
       Optional hits_addend for the rate limit descriptor. If set the value will override the
 request level hits_addend.
      .google.protobuf.UInt64Value hits_addend = 3;
      Specified by:
      getHitsAddend in interface RateLimitDescriptorOrBuilder
      Returns:
      The hitsAddend.

    • getHitsAddendOrBuilder

      public com.google.protobuf.UInt64ValueOrBuilder getHitsAddendOrBuilder()
       Optional hits_addend for the rate limit descriptor. If set the value will override the
 request level hits_addend.
      .google.protobuf.UInt64Value hits_addend = 3;
      Specified by:
      getHitsAddendOrBuilder in interface RateLimitDescriptorOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateLimitDescriptor.Builder newBuilder()

    • newBuilder

      public static RateLimitDescriptor.Builder newBuilder(RateLimitDescriptor prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RateLimitDescriptor getDefaultInstance()

    • parser

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

    • getParserForType

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