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

Class RateLimitResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitResponseOrBuilder, Serializable
public final class RateLimitResponse extends com.google.protobuf.GeneratedMessageV3 implements RateLimitResponseOrBuilder
 A response from a ShouldRateLimit call.
 [#next-free-field: 8]
Protobuf type envoy.service.ratelimit.v3.RateLimitResponse
See Also:

  • Field Details

    • OVERALL_CODE_FIELD_NUMBER

      public static final int OVERALL_CODE_FIELD_NUMBER
      See Also:

    • STATUSES_FIELD_NUMBER

      public static final int STATUSES_FIELD_NUMBER
      See Also:

    • RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER

      public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
      See Also:

    • REQUEST_HEADERS_TO_ADD_FIELD_NUMBER

      public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
      See Also:

    • RAW_BODY_FIELD_NUMBER

      public static final int RAW_BODY_FIELD_NUMBER
      See Also:

    • DYNAMIC_METADATA_FIELD_NUMBER

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

    • getOverallCodeValue

      public 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;
      Specified by:
      getOverallCodeValue in interface RateLimitResponseOrBuilder
      Returns:
      The enum numeric value on the wire for overallCode.

    • getOverallCode

      public 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;
      Specified by:
      getOverallCode in interface RateLimitResponseOrBuilder
      Returns:
      The overallCode.

    • getStatusesList

      public 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;
      Specified by:
      getStatusesList in interface RateLimitResponseOrBuilder

    • getStatusesOrBuilderList

      public 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;
      Specified by:
      getStatusesOrBuilderList in interface RateLimitResponseOrBuilder

    • getStatusesCount

      public 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;
      Specified by:
      getStatusesCount in interface RateLimitResponseOrBuilder

    • getStatuses

      public 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;
      Specified by:
      getStatuses in interface RateLimitResponseOrBuilder

    • getStatusesOrBuilder

      public 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;
      Specified by:
      getStatusesOrBuilder in interface RateLimitResponseOrBuilder

    • getResponseHeadersToAddList

      public List<HeaderValue> getResponseHeadersToAddList()
       A list of headers to add to the response
      repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;
      Specified by:
      getResponseHeadersToAddList in interface RateLimitResponseOrBuilder

    • getResponseHeadersToAddOrBuilderList

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

    • getResponseHeadersToAddCount

      public int getResponseHeadersToAddCount()
       A list of headers to add to the response
      repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;
      Specified by:
      getResponseHeadersToAddCount in interface RateLimitResponseOrBuilder

    • getResponseHeadersToAdd

      public HeaderValue getResponseHeadersToAdd(int index)
       A list of headers to add to the response
      repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;
      Specified by:
      getResponseHeadersToAdd in interface RateLimitResponseOrBuilder

    • getResponseHeadersToAddOrBuilder

      public HeaderValueOrBuilder getResponseHeadersToAddOrBuilder(int index)
       A list of headers to add to the response
      repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;
      Specified by:
      getResponseHeadersToAddOrBuilder in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddList

      public 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;
      Specified by:
      getRequestHeadersToAddList in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddOrBuilderList

      public 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;
      Specified by:
      getRequestHeadersToAddOrBuilderList in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddCount

      public int getRequestHeadersToAddCount()
       A list of headers to add to the request when forwarded
      repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;
      Specified by:
      getRequestHeadersToAddCount in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAdd

      public 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;
      Specified by:
      getRequestHeadersToAdd in interface RateLimitResponseOrBuilder

    • getRequestHeadersToAddOrBuilder

      public 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;
      Specified by:
      getRequestHeadersToAddOrBuilder in interface RateLimitResponseOrBuilder

    • getRawBody

      public 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;
      Specified by:
      getRawBody in interface RateLimitResponseOrBuilder
      Returns:
      The rawBody.

    • hasDynamicMetadata

      public 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;
      Specified by:
      hasDynamicMetadata in interface RateLimitResponseOrBuilder
      Returns:
      Whether the dynamicMetadata field is set.

    • getDynamicMetadata

      public 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;
      Specified by:
      getDynamicMetadata in interface RateLimitResponseOrBuilder
      Returns:
      The dynamicMetadata.

    • getDynamicMetadataOrBuilder

      public 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;
      Specified by:
      getDynamicMetadataOrBuilder in interface RateLimitResponseOrBuilder

    • hasQuota

      public 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;
      Specified by:
      hasQuota in interface RateLimitResponseOrBuilder
      Returns:
      Whether the quota field is set.

    • getQuota

      public 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;
      Specified by:
      getQuota in interface RateLimitResponseOrBuilder
      Returns:
      The quota.

    • getQuotaOrBuilder

      public 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;
      Specified by:
      getQuotaOrBuilder in interface RateLimitResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RateLimitResponse 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateLimitResponse.Builder newBuilder()

    • newBuilder

      public static RateLimitResponse.Builder newBuilder(RateLimitResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RateLimitResponse getDefaultInstance()

    • parser

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

    • getParserForType

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