Package io.envoyproxy.envoy.service.ratelimit.v3

Class RateLimitResponse.DescriptorStatus

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitResponse.DescriptorStatusOrBuilder, Serializable
Enclosing class:
RateLimitResponse
public static final class RateLimitResponse.DescriptorStatus extends com.google.protobuf.GeneratedMessageV3 implements RateLimitResponse.DescriptorStatusOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus
See Also:

  • Field Details

    • CODE_FIELD_NUMBER

      public static final int CODE_FIELD_NUMBER
      See Also:

    • CURRENT_LIMIT_FIELD_NUMBER

      public static final int CURRENT_LIMIT_FIELD_NUMBER
      See Also:

    • LIMIT_REMAINING_FIELD_NUMBER

      public static final int LIMIT_REMAINING_FIELD_NUMBER
      See Also:

    • DURATION_UNTIL_RESET_FIELD_NUMBER

      public static final int DURATION_UNTIL_RESET_FIELD_NUMBER
      See Also:

    • QUOTA_FIELD_NUMBER

      public static final int QUOTA_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

    • getCodeValue

      public int getCodeValue()
       The response code for an individual descriptor.
      .envoy.service.ratelimit.v3.RateLimitResponse.Code code = 1;
      Specified by:
      getCodeValue in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      The enum numeric value on the wire for code.

    • getCode

      public RateLimitResponse.Code getCode()
       The response code for an individual descriptor.
      .envoy.service.ratelimit.v3.RateLimitResponse.Code code = 1;
      Specified by:
      getCode in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      The code.

    • hasCurrentLimit

      public boolean hasCurrentLimit()
       The current limit as configured by the server. Useful for debugging, etc.
      .envoy.service.ratelimit.v3.RateLimitResponse.RateLimit current_limit = 2;
      Specified by:
      hasCurrentLimit in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      Whether the currentLimit field is set.

    • getCurrentLimit

      public RateLimitResponse.RateLimit getCurrentLimit()
       The current limit as configured by the server. Useful for debugging, etc.
      .envoy.service.ratelimit.v3.RateLimitResponse.RateLimit current_limit = 2;
      Specified by:
      getCurrentLimit in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      The currentLimit.

    • getCurrentLimitOrBuilder

      public RateLimitResponse.RateLimitOrBuilder getCurrentLimitOrBuilder()
       The current limit as configured by the server. Useful for debugging, etc.
      .envoy.service.ratelimit.v3.RateLimitResponse.RateLimit current_limit = 2;
      Specified by:
      getCurrentLimitOrBuilder in interface RateLimitResponse.DescriptorStatusOrBuilder

    • getLimitRemaining

      public int getLimitRemaining()
       The limit remaining in the current time unit.
      uint32 limit_remaining = 3;
      Specified by:
      getLimitRemaining in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      The limitRemaining.

    • hasDurationUntilReset

      public boolean hasDurationUntilReset()
       Duration until reset of the current limit window.
      .google.protobuf.Duration duration_until_reset = 4;
      Specified by:
      hasDurationUntilReset in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      Whether the durationUntilReset field is set.

    • getDurationUntilReset

      public com.google.protobuf.Duration getDurationUntilReset()
       Duration until reset of the current limit window.
      .google.protobuf.Duration duration_until_reset = 4;
      Specified by:
      getDurationUntilReset in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      The durationUntilReset.

    • getDurationUntilResetOrBuilder

      public com.google.protobuf.DurationOrBuilder getDurationUntilResetOrBuilder()
       Duration until reset of the current limit window.
      .google.protobuf.Duration duration_until_reset = 4;
      Specified by:
      getDurationUntilResetOrBuilder in interface RateLimitResponse.DescriptorStatusOrBuilder

    • hasQuota

      public boolean hasQuota()
       Quota is available for a request if its descriptor set has cached quota available for all
 descriptors.
 This is for each individual descriptor in the descriptor set. The client will perform matches for each individual descriptor against available per-descriptor quota.

 If quota is available, a RLS request will not be made and the quota will be reduced by 1 for
 all matching descriptors.

 If there is not sufficient quota, there are three cases:
 1. A cached entry exists for a RLS descriptor that is out-of-quota, but not expired.
    In this case, the request will be treated as OVER_LIMIT.
 2. Some RLS descriptors have a cached entry that has valid quota but some RLS descriptors
    have no cached entry. This will trigger a new RLS request.
    When the result is returned, a single unit will be consumed from the quota for all
    matching descriptors.
    If the server did not provide a quota, such as the quota message is empty for some of
    the descriptors, then the request admission is determined by the
    :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 3. All RLS descriptors lack a cached entry, this will trigger a new RLS request,
    When the result is returned, a single unit will be consumed from the quota for all
    matching descriptors.
    If the server did not provide a quota, such as the quota message is empty for some of
    the descriptors, then the request admission is determined by the
    :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 [#not-implemented-hide:]
      .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 5;
      Specified by:
      hasQuota in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      Whether the quota field is set.

    • getQuota

      public RateLimitResponse.Quota getQuota()
       Quota is available for a request if its descriptor set has cached quota available for all
 descriptors.
 This is for each individual descriptor in the descriptor set. The client will perform matches for each individual descriptor against available per-descriptor quota.

 If quota is available, a RLS request will not be made and the quota will be reduced by 1 for
 all matching descriptors.

 If there is not sufficient quota, there are three cases:
 1. A cached entry exists for a RLS descriptor that is out-of-quota, but not expired.
    In this case, the request will be treated as OVER_LIMIT.
 2. Some RLS descriptors have a cached entry that has valid quota but some RLS descriptors
    have no cached entry. This will trigger a new RLS request.
    When the result is returned, a single unit will be consumed from the quota for all
    matching descriptors.
    If the server did not provide a quota, such as the quota message is empty for some of
    the descriptors, then the request admission is determined by the
    :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 3. All RLS descriptors lack a cached entry, this will trigger a new RLS request,
    When the result is returned, a single unit will be consumed from the quota for all
    matching descriptors.
    If the server did not provide a quota, such as the quota message is empty for some of
    the descriptors, then the request admission is determined by the
    :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 [#not-implemented-hide:]
      .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 5;
      Specified by:
      getQuota in interface RateLimitResponse.DescriptorStatusOrBuilder
      Returns:
      The quota.

    • getQuotaOrBuilder

      public RateLimitResponse.QuotaOrBuilder getQuotaOrBuilder()
       Quota is available for a request if its descriptor set has cached quota available for all
 descriptors.
 This is for each individual descriptor in the descriptor set. The client will perform matches for each individual descriptor against available per-descriptor quota.

 If quota is available, a RLS request will not be made and the quota will be reduced by 1 for
 all matching descriptors.

 If there is not sufficient quota, there are three cases:
 1. A cached entry exists for a RLS descriptor that is out-of-quota, but not expired.
    In this case, the request will be treated as OVER_LIMIT.
 2. Some RLS descriptors have a cached entry that has valid quota but some RLS descriptors
    have no cached entry. This will trigger a new RLS request.
    When the result is returned, a single unit will be consumed from the quota for all
    matching descriptors.
    If the server did not provide a quota, such as the quota message is empty for some of
    the descriptors, then the request admission is determined by the
    :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 3. All RLS descriptors lack a cached entry, this will trigger a new RLS request,
    When the result is returned, a single unit will be consumed from the quota for all
    matching descriptors.
    If the server did not provide a quota, such as the quota message is empty for some of
    the descriptors, then the request admission is determined by the
    :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 [#not-implemented-hide:]
      .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 5;
      Specified by:
      getQuotaOrBuilder in interface RateLimitResponse.DescriptorStatusOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RateLimitResponse.DescriptorStatus parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RateLimitResponse.DescriptorStatus parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateLimitResponse.DescriptorStatus.Builder newBuilder()

    • newBuilder

      public static RateLimitResponse.DescriptorStatus.Builder newBuilder(RateLimitResponse.DescriptorStatus prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RateLimitResponse.DescriptorStatus getDefaultInstance()

    • parser

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

    • getParserForType

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