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

Interface RateLimitResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RateLimitResponse, RateLimitResponse.Builder
    public interface RateLimitResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getOverallCodeValue

        int getOverallCodeValue()
         The overall response code which takes into account all of the descriptors that were passed
 in the RateLimitRequest message.
        .envoy.service.ratelimit.v3.RateLimitResponse.Code overall_code = 1;
        Returns:
        The enum numeric value on the wire for overallCode.

      • getOverallCode

        RateLimitResponse.Code getOverallCode()
         The overall response code which takes into account all of the descriptors that were passed
 in the RateLimitRequest message.
        .envoy.service.ratelimit.v3.RateLimitResponse.Code overall_code = 1;
        Returns:
        The overallCode.

      • getStatusesList

        List<RateLimitResponse.DescriptorStatus> getStatusesList()
         A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
        repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;

      • getStatuses

        RateLimitResponse.DescriptorStatus getStatuses​(int index)
         A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
        repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;

      • getStatusesCount

        int getStatusesCount()
         A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
        repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;

      • getStatusesOrBuilderList

        List<? extends RateLimitResponse.DescriptorStatusOrBuilder> getStatusesOrBuilderList()
         A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
        repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;

      • getStatusesOrBuilder

        RateLimitResponse.DescriptorStatusOrBuilder getStatusesOrBuilder​(int index)
         A list of DescriptorStatus messages which matches the length of the descriptor list passed
 in the RateLimitRequest. This can be used by the caller to determine which individual
 descriptors failed and/or what the currently configured limits are for all of them.
        repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;

      • getResponseHeadersToAddList

        List<HeaderValue> getResponseHeadersToAddList()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getResponseHeadersToAdd

        HeaderValue getResponseHeadersToAdd​(int index)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getResponseHeadersToAddCount

        int getResponseHeadersToAddCount()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getResponseHeadersToAddOrBuilderList

        List<? extends HeaderValueOrBuilder> getResponseHeadersToAddOrBuilderList()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getResponseHeadersToAddOrBuilder

        HeaderValueOrBuilder getResponseHeadersToAddOrBuilder​(int index)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getRequestHeadersToAddList

        List<HeaderValue> getRequestHeadersToAddList()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRequestHeadersToAdd

        HeaderValue getRequestHeadersToAdd​(int index)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRequestHeadersToAddCount

        int getRequestHeadersToAddCount()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRequestHeadersToAddOrBuilderList

        List<? extends HeaderValueOrBuilder> getRequestHeadersToAddOrBuilderList()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRequestHeadersToAddOrBuilder

        HeaderValueOrBuilder getRequestHeadersToAddOrBuilder​(int index)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRawBody

        com.google.protobuf.ByteString getRawBody()
         A response body to send to the downstream client when the response code is not OK.
        bytes raw_body = 5;
        Returns:
        The rawBody.

      • hasDynamicMetadata

        boolean hasDynamicMetadata()
         Optional response metadata that will be emitted as dynamic metadata to be consumed by the next
 filter. This metadata lives in a namespace specified by the canonical name of extension filter
 that requires it:
 - :ref:`envoy.filters.http.ratelimit <config_http_filters_ratelimit_dynamic_metadata>` for HTTP filter.
 - :ref:`envoy.filters.network.ratelimit <config_network_filters_ratelimit_dynamic_metadata>` for network filter.
 - :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit_dynamic_metadata>` for Thrift filter.
        .google.protobuf.Struct dynamic_metadata = 6;
        Returns:
        Whether the dynamicMetadata field is set.

      • getDynamicMetadata

        com.google.protobuf.Struct getDynamicMetadata()
         Optional response metadata that will be emitted as dynamic metadata to be consumed by the next
 filter. This metadata lives in a namespace specified by the canonical name of extension filter
 that requires it:
 - :ref:`envoy.filters.http.ratelimit <config_http_filters_ratelimit_dynamic_metadata>` for HTTP filter.
 - :ref:`envoy.filters.network.ratelimit <config_network_filters_ratelimit_dynamic_metadata>` for network filter.
 - :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit_dynamic_metadata>` for Thrift filter.
        .google.protobuf.Struct dynamic_metadata = 6;
        Returns:
        The dynamicMetadata.

      • getDynamicMetadataOrBuilder

        com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
         Optional response metadata that will be emitted as dynamic metadata to be consumed by the next
 filter. This metadata lives in a namespace specified by the canonical name of extension filter
 that requires it:
 - :ref:`envoy.filters.http.ratelimit <config_http_filters_ratelimit_dynamic_metadata>` for HTTP filter.
 - :ref:`envoy.filters.network.ratelimit <config_network_filters_ratelimit_dynamic_metadata>` for network filter.
 - :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit_dynamic_metadata>` for Thrift filter.
        .google.protobuf.Struct dynamic_metadata = 6;

      • hasQuota

        boolean hasQuota()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;
        Returns:
        Whether the quota field is set.

      • getQuota

        RateLimitResponse.Quota getQuota()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;
        Returns:
        The quota.

      • getQuotaOrBuilder

        RateLimitResponse.QuotaOrBuilder getQuotaOrBuilder()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;