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

Class RateLimitResponse.DescriptorStatus.Builder

    • Method Detail

      • 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.Builder<RateLimitResponse.DescriptorStatus.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitResponse.DescriptorStatus.Builder>

      • getDefaultInstanceForType

        public RateLimitResponse.DescriptorStatus getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitResponse.DescriptorStatus.Builder>

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

      • setCodeValue

        public RateLimitResponse.DescriptorStatus.Builder setCodeValue​(int value)
         The response code for an individual descriptor.
        .envoy.service.ratelimit.v3.RateLimitResponse.Code code = 1;
        Parameters:
        value - The enum numeric value on the wire for code to set.
        Returns:
        This builder for chaining.

      • clearCode

        public RateLimitResponse.DescriptorStatus.Builder clearCode()
         The response code for an individual descriptor.
        .envoy.service.ratelimit.v3.RateLimitResponse.Code code = 1;
        Returns:
        This builder for chaining.

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

      • clearCurrentLimit

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

      • getCurrentLimitBuilder

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

      • setLimitRemaining

        public RateLimitResponse.DescriptorStatus.Builder setLimitRemaining​(int value)
         The limit remaining in the current time unit.
        uint32 limit_remaining = 3;
        Parameters:
        value - The limitRemaining to set.
        Returns:
        This builder for chaining.

      • setDurationUntilReset

        public RateLimitResponse.DescriptorStatus.Builder setDurationUntilReset​(com.google.protobuf.Duration value)
         Duration until reset of the current limit window.
        .google.protobuf.Duration duration_until_reset = 4;

      • setDurationUntilReset

        public RateLimitResponse.DescriptorStatus.Builder setDurationUntilReset​(com.google.protobuf.Duration.Builder builderForValue)
         Duration until reset of the current limit window.
        .google.protobuf.Duration duration_until_reset = 4;

      • mergeDurationUntilReset

        public RateLimitResponse.DescriptorStatus.Builder mergeDurationUntilReset​(com.google.protobuf.Duration value)
         Duration until reset of the current limit window.
        .google.protobuf.Duration duration_until_reset = 4;

      • getDurationUntilResetBuilder

        public com.google.protobuf.Duration.Builder getDurationUntilResetBuilder()
         Duration until reset of the current limit window.
        .google.protobuf.Duration duration_until_reset = 4;

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

      • setQuota

        public RateLimitResponse.DescriptorStatus.Builder setQuota​(RateLimitResponse.Quota value)
         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;

      • setQuota

        public RateLimitResponse.DescriptorStatus.Builder setQuota​(RateLimitResponse.Quota.Builder builderForValue)
         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;

      • mergeQuota

        public RateLimitResponse.DescriptorStatus.Builder mergeQuota​(RateLimitResponse.Quota value)
         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;

      • clearQuota

        public RateLimitResponse.DescriptorStatus.Builder clearQuota()
         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;

      • getQuotaBuilder

        public RateLimitResponse.Quota.Builder getQuotaBuilder()
         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;

      • 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