All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponseOrBuilder Maven / Gradle / Ivy

There is a newer version: 1.0.46
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/service/ratelimit/v3/rls.proto

package io.envoyproxy.envoy.service.ratelimit.v3;

public interface RateLimitResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.service.ratelimit.v3.RateLimitResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   * 
   * 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; * @return The enum numeric value on the wire for overallCode. */ 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; * @return The overallCode. */ io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponse.Code getOverallCode(); /** *
   * 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; */ java.util.List 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; */ io.envoyproxy.envoy.service.ratelimit.v3.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; */ 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; */ java.util.List 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; */ io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatusOrBuilder getStatusesOrBuilder( int index); /** *
   * A list of headers to add to the response
   * 
* * repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; */ java.util.List getResponseHeadersToAddList(); /** *
   * A list of headers to add to the response
   * 
* * repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; */ io.envoyproxy.envoy.config.core.v3.HeaderValue getResponseHeadersToAdd(int index); /** *
   * A list of headers to add to the response
   * 
* * repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; */ int getResponseHeadersToAddCount(); /** *
   * A list of headers to add to the response
   * 
* * repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; */ java.util.List getResponseHeadersToAddOrBuilderList(); /** *
   * A list of headers to add to the response
   * 
* * repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; */ io.envoyproxy.envoy.config.core.v3.HeaderValueOrBuilder getResponseHeadersToAddOrBuilder( int index); /** *
   * A list of headers to add to the request when forwarded
   * 
* * repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; */ java.util.List getRequestHeadersToAddList(); /** *
   * A list of headers to add to the request when forwarded
   * 
* * repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; */ io.envoyproxy.envoy.config.core.v3.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; */ int getRequestHeadersToAddCount(); /** *
   * A list of headers to add to the request when forwarded
   * 
* * repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; */ java.util.List getRequestHeadersToAddOrBuilderList(); /** *
   * A list of headers to add to the request when forwarded
   * 
* * repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; */ io.envoyproxy.envoy.config.core.v3.HeaderValueOrBuilder getRequestHeadersToAddOrBuilder( int index); /** *
   * A response body to send to the downstream client when the response code is not OK.
   * 
* * bytes raw_body = 5; * @return The rawBody. */ com.google.protobuf.ByteString getRawBody(); /** *
   * 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; * @return Whether the dynamicMetadata field is set. */ 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; * @return The dynamicMetadata. */ 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; */ com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder(); /** *
   * 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; * @return Whether the quota field is set. */ 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; * @return The quota. */ io.envoyproxy.envoy.service.ratelimit.v3.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; */ io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponse.QuotaOrBuilder getQuotaOrBuilder(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy