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

Interface RateLimitResponse.DescriptorStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimitResponse.DescriptorStatus, RateLimitResponse.DescriptorStatus.Builder
Enclosing class:
RateLimitResponse
public static interface RateLimitResponse.DescriptorStatusOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    RateLimitResponse.Code
    getCode()
    The response code for an individual descriptor.
    int
    getCodeValue()
    The response code for an individual descriptor.
    RateLimitResponse.RateLimit
    getCurrentLimit()
    The current limit as configured by the server.
    RateLimitResponse.RateLimitOrBuilder
    getCurrentLimitOrBuilder()
    The current limit as configured by the server.
    com.google.protobuf.Duration
    getDurationUntilReset()
    Duration until reset of the current limit window.
    com.google.protobuf.DurationOrBuilder
    getDurationUntilResetOrBuilder()
    Duration until reset of the current limit window.
    int
    getLimitRemaining()
    The limit remaining in the current time unit.
    RateLimitResponse.Quota
    getQuota()
    Quota is available for a request if its descriptor set has cached quota available for all descriptors.
    RateLimitResponse.QuotaOrBuilder
    getQuotaOrBuilder()
    Quota is available for a request if its descriptor set has cached quota available for all descriptors.
    boolean
    hasCurrentLimit()
    The current limit as configured by the server.
    boolean
    hasDurationUntilReset()
    Duration until reset of the current limit window.
    boolean
    hasQuota()
    Quota is available for a request if its descriptor set has cached quota available for all descriptors.

    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

    • getCodeValue

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

    • getCode

      RateLimitResponse.Code getCode()
       The response code for an individual descriptor.
      .envoy.service.ratelimit.v3.RateLimitResponse.Code code = 1;
      Returns:
      The code.

    • hasCurrentLimit

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

    • getCurrentLimit

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

    • getCurrentLimitOrBuilder

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

    • getLimitRemaining

      int getLimitRemaining()
       The limit remaining in the current time unit.
      uint32 limit_remaining = 3;
      Returns:
      The limitRemaining.

    • hasDurationUntilReset

      boolean hasDurationUntilReset()
       Duration until reset of the current limit window.
      .google.protobuf.Duration duration_until_reset = 4;
      Returns:
      Whether the durationUntilReset field is set.

    • getDurationUntilReset

      com.google.protobuf.Duration getDurationUntilReset()
       Duration until reset of the current limit window.
      .google.protobuf.Duration duration_until_reset = 4;
      Returns:
      The durationUntilReset.

    • getDurationUntilResetOrBuilder

      com.google.protobuf.DurationOrBuilder getDurationUntilResetOrBuilder()
       Duration until reset of the current limit window.
      .google.protobuf.Duration duration_until_reset = 4;

    • hasQuota

      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;
      Returns:
      Whether the quota field is set.

    • getQuota

      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;
      Returns:
      The quota.

    • getQuotaOrBuilder

      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;