io.envoyproxy.envoy.config.route.v4alpha

Interface RetryPolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RetryPolicy, RetryPolicy.Builder

public interface RetryPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
long	getHostSelectionRetryMaxAttempts() The maximum number of times host selection will be reattempted before giving up, at which point the host that was last selected will be routed to.
com.google.protobuf.UInt32Value	getMaxRetries() Specifies the allowed number of retries.
com.google.protobuf.UInt32ValueOrBuilder	getMaxRetriesOrBuilder() Specifies the allowed number of retries.
com.google.protobuf.Duration	getPerTryTimeout() Specifies a non-zero upstream timeout per retry attempt.
com.google.protobuf.DurationOrBuilder	getPerTryTimeoutOrBuilder() Specifies a non-zero upstream timeout per retry attempt.
RetryPolicy.RateLimitedRetryBackOff	getRateLimitedRetryBackOff() Specifies parameters that control a retry back-off strategy that is used when the request is rate limited by the upstream server.
RetryPolicy.RateLimitedRetryBackOffOrBuilder	getRateLimitedRetryBackOffOrBuilder() Specifies parameters that control a retry back-off strategy that is used when the request is rate limited by the upstream server.
HeaderMatcher	getRetriableHeaders(int index) HTTP response headers that trigger a retry if present in the response.
int	getRetriableHeadersCount() HTTP response headers that trigger a retry if present in the response.
List<HeaderMatcher>	getRetriableHeadersList() HTTP response headers that trigger a retry if present in the response.
HeaderMatcherOrBuilder	getRetriableHeadersOrBuilder(int index) HTTP response headers that trigger a retry if present in the response.
List<? extends HeaderMatcherOrBuilder>	getRetriableHeadersOrBuilderList() HTTP response headers that trigger a retry if present in the response.
HeaderMatcher	getRetriableRequestHeaders(int index) HTTP headers which must be present in the request for retries to be attempted.
int	getRetriableRequestHeadersCount() HTTP headers which must be present in the request for retries to be attempted.
List<HeaderMatcher>	getRetriableRequestHeadersList() HTTP headers which must be present in the request for retries to be attempted.
HeaderMatcherOrBuilder	getRetriableRequestHeadersOrBuilder(int index) HTTP headers which must be present in the request for retries to be attempted.
List<? extends HeaderMatcherOrBuilder>	getRetriableRequestHeadersOrBuilderList() HTTP headers which must be present in the request for retries to be attempted.
int	getRetriableStatusCodes(int index) HTTP status codes that should trigger a retry in addition to those specified by retry_on.
int	getRetriableStatusCodesCount() HTTP status codes that should trigger a retry in addition to those specified by retry_on.
List<Integer>	getRetriableStatusCodesList() HTTP status codes that should trigger a retry in addition to those specified by retry_on.
RetryPolicy.RetryBackOff	getRetryBackOff() Specifies parameters that control exponential retry back off.
RetryPolicy.RetryBackOffOrBuilder	getRetryBackOffOrBuilder() Specifies parameters that control exponential retry back off.
RetryPolicy.RetryHostPredicate	getRetryHostPredicate(int index) Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
int	getRetryHostPredicateCount() Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
List<RetryPolicy.RetryHostPredicate>	getRetryHostPredicateList() Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
RetryPolicy.RetryHostPredicateOrBuilder	getRetryHostPredicateOrBuilder(int index) Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
List<? extends RetryPolicy.RetryHostPredicateOrBuilder>	getRetryHostPredicateOrBuilderList() Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
String	getRetryOn() Specifies the conditions under which retry takes place.
com.google.protobuf.ByteString	getRetryOnBytes() Specifies the conditions under which retry takes place.
RetryPolicy.RetryPriority	getRetryPriority() Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.
RetryPolicy.RetryPriorityOrBuilder	getRetryPriorityOrBuilder() Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.
boolean	hasMaxRetries() Specifies the allowed number of retries.
boolean	hasPerTryTimeout() Specifies a non-zero upstream timeout per retry attempt.
boolean	hasRateLimitedRetryBackOff() Specifies parameters that control a retry back-off strategy that is used when the request is rate limited by the upstream server.
boolean	hasRetryBackOff() Specifies parameters that control exponential retry back off.
boolean	hasRetryPriority() Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRetryOn

String getRetryOn()

 Specifies the conditions under which retry takes place. These are the same
 conditions documented for :ref:`config_http_filters_router_x-envoy-retry-on` and
 :ref:`config_http_filters_router_x-envoy-retry-grpc-on`.
 

string retry_on = 1;

getRetryOnBytes

com.google.protobuf.ByteString getRetryOnBytes()

 Specifies the conditions under which retry takes place. These are the same
 conditions documented for :ref:`config_http_filters_router_x-envoy-retry-on` and
 :ref:`config_http_filters_router_x-envoy-retry-grpc-on`.
 

string retry_on = 1;

hasMaxRetries

boolean hasMaxRetries()

 Specifies the allowed number of retries. This parameter is optional and
 defaults to 1. These are the same conditions documented for
 :ref:`config_http_filters_router_x-envoy-max-retries`.
 

.google.protobuf.UInt32Value max_retries = 2;

getMaxRetries

com.google.protobuf.UInt32Value getMaxRetries()

 Specifies the allowed number of retries. This parameter is optional and
 defaults to 1. These are the same conditions documented for
 :ref:`config_http_filters_router_x-envoy-max-retries`.
 

.google.protobuf.UInt32Value max_retries = 2;

getMaxRetriesOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getMaxRetriesOrBuilder()

 Specifies the allowed number of retries. This parameter is optional and
 defaults to 1. These are the same conditions documented for
 :ref:`config_http_filters_router_x-envoy-max-retries`.
 

.google.protobuf.UInt32Value max_retries = 2;

hasPerTryTimeout

boolean hasPerTryTimeout()

 Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
 same conditions documented for
 :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
 .. note::
   If left unspecified, Envoy will use the global
   :ref:`route timeout <envoy_api_field_config.route.v4alpha.RouteAction.timeout>` for the request.
   Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
   retry policy, a request that times out will not be retried as the total timeout budget
   would have been exhausted.
 

.google.protobuf.Duration per_try_timeout = 3;

getPerTryTimeout

com.google.protobuf.Duration getPerTryTimeout()

 Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
 same conditions documented for
 :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
 .. note::
   If left unspecified, Envoy will use the global
   :ref:`route timeout <envoy_api_field_config.route.v4alpha.RouteAction.timeout>` for the request.
   Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
   retry policy, a request that times out will not be retried as the total timeout budget
   would have been exhausted.
 

.google.protobuf.Duration per_try_timeout = 3;

getPerTryTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getPerTryTimeoutOrBuilder()

 Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
 same conditions documented for
 :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
 .. note::
   If left unspecified, Envoy will use the global
   :ref:`route timeout <envoy_api_field_config.route.v4alpha.RouteAction.timeout>` for the request.
   Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
   retry policy, a request that times out will not be retried as the total timeout budget
   would have been exhausted.
 

.google.protobuf.Duration per_try_timeout = 3;

hasRetryPriority

boolean hasRetryPriority()

 Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries. Refer to
 :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
 

.envoy.config.route.v4alpha.RetryPolicy.RetryPriority retry_priority = 4;

getRetryPriority

RetryPolicy.RetryPriority getRetryPriority()

 Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries. Refer to
 :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
 

.envoy.config.route.v4alpha.RetryPolicy.RetryPriority retry_priority = 4;

getRetryPriorityOrBuilder

RetryPolicy.RetryPriorityOrBuilder getRetryPriorityOrBuilder()

 Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries. Refer to
 :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
 

.envoy.config.route.v4alpha.RetryPolicy.RetryPriority retry_priority = 4;

getRetryHostPredicateList

List<RetryPolicy.RetryHostPredicate> getRetryHostPredicateList()

 Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
 

repeated .envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicate

RetryPolicy.RetryHostPredicate getRetryHostPredicate(int index)

 Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
 

repeated .envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicateCount

int getRetryHostPredicateCount()

 Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
 

repeated .envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicateOrBuilderList

List<? extends RetryPolicy.RetryHostPredicateOrBuilder> getRetryHostPredicateOrBuilderList()

 Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
 

repeated .envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicateOrBuilder

RetryPolicy.RetryHostPredicateOrBuilder getRetryHostPredicateOrBuilder(int index)

 Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
 for retries. If any of the predicates reject the host, host selection will be reattempted.
 Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
 details.
 

repeated .envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getHostSelectionRetryMaxAttempts

long getHostSelectionRetryMaxAttempts()

 The maximum number of times host selection will be reattempted before giving up, at which
 point the host that was last selected will be routed to. If unspecified, this will default to
 retrying once.
 

int64 host_selection_retry_max_attempts = 6;

getRetriableStatusCodesList

List<Integer> getRetriableStatusCodesList()

 HTTP status codes that should trigger a retry in addition to those specified by retry_on.
 

repeated uint32 retriable_status_codes = 7;

getRetriableStatusCodesCount

int getRetriableStatusCodesCount()

 HTTP status codes that should trigger a retry in addition to those specified by retry_on.
 

repeated uint32 retriable_status_codes = 7;

getRetriableStatusCodes

int getRetriableStatusCodes(int index)

 HTTP status codes that should trigger a retry in addition to those specified by retry_on.
 

repeated uint32 retriable_status_codes = 7;

hasRetryBackOff

boolean hasRetryBackOff()

 Specifies parameters that control exponential retry back off. This parameter is optional, in which case the
 default base interval is 25 milliseconds or, if set, the current value of the
 `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
 the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
 describes Envoy's back-off algorithm.
 

.envoy.config.route.v4alpha.RetryPolicy.RetryBackOff retry_back_off = 8;

getRetryBackOff

RetryPolicy.RetryBackOff getRetryBackOff()

 Specifies parameters that control exponential retry back off. This parameter is optional, in which case the
 default base interval is 25 milliseconds or, if set, the current value of the
 `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
 the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
 describes Envoy's back-off algorithm.
 

.envoy.config.route.v4alpha.RetryPolicy.RetryBackOff retry_back_off = 8;

getRetryBackOffOrBuilder

RetryPolicy.RetryBackOffOrBuilder getRetryBackOffOrBuilder()

 Specifies parameters that control exponential retry back off. This parameter is optional, in which case the
 default base interval is 25 milliseconds or, if set, the current value of the
 `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
 the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
 describes Envoy's back-off algorithm.
 

.envoy.config.route.v4alpha.RetryPolicy.RetryBackOff retry_back_off = 8;

hasRateLimitedRetryBackOff

boolean hasRateLimitedRetryBackOff()

 Specifies parameters that control a retry back-off strategy that is used
 when the request is rate limited by the upstream server. The server may
 return a response header like ``Retry-After`` or ``X-RateLimit-Reset`` to
 provide feedback to the client on how long to wait before retrying. If
 configured, this back-off strategy will be used instead of the
 default exponential back off strategy (configured using `retry_back_off`)
 whenever a response includes the matching headers.
 

.envoy.config.route.v4alpha.RetryPolicy.RateLimitedRetryBackOff rate_limited_retry_back_off = 11;

getRateLimitedRetryBackOff

RetryPolicy.RateLimitedRetryBackOff getRateLimitedRetryBackOff()

 Specifies parameters that control a retry back-off strategy that is used
 when the request is rate limited by the upstream server. The server may
 return a response header like ``Retry-After`` or ``X-RateLimit-Reset`` to
 provide feedback to the client on how long to wait before retrying. If
 configured, this back-off strategy will be used instead of the
 default exponential back off strategy (configured using `retry_back_off`)
 whenever a response includes the matching headers.
 

.envoy.config.route.v4alpha.RetryPolicy.RateLimitedRetryBackOff rate_limited_retry_back_off = 11;

getRateLimitedRetryBackOffOrBuilder

RetryPolicy.RateLimitedRetryBackOffOrBuilder getRateLimitedRetryBackOffOrBuilder()

 Specifies parameters that control a retry back-off strategy that is used
 when the request is rate limited by the upstream server. The server may
 return a response header like ``Retry-After`` or ``X-RateLimit-Reset`` to
 provide feedback to the client on how long to wait before retrying. If
 configured, this back-off strategy will be used instead of the
 default exponential back off strategy (configured using `retry_back_off`)
 whenever a response includes the matching headers.
 

.envoy.config.route.v4alpha.RetryPolicy.RateLimitedRetryBackOff rate_limited_retry_back_off = 11;

getRetriableHeadersList

List<HeaderMatcher> getRetriableHeadersList()

 HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_headers = 9;

getRetriableHeaders

HeaderMatcher getRetriableHeaders(int index)

 HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_headers = 9;

getRetriableHeadersCount

int getRetriableHeadersCount()

 HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_headers = 9;

getRetriableHeadersOrBuilderList

List<? extends HeaderMatcherOrBuilder> getRetriableHeadersOrBuilderList()

 HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_headers = 9;

getRetriableHeadersOrBuilder

HeaderMatcherOrBuilder getRetriableHeadersOrBuilder(int index)

 HTTP response headers that trigger a retry if present in the response. A retry will be
 triggered if any of the header matches match the upstream response headers.
 The field is only consulted if 'retriable-headers' retry policy is active.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_headers = 9;

getRetriableRequestHeadersList

List<HeaderMatcher> getRetriableRequestHeadersList()

 HTTP headers which must be present in the request for retries to be attempted.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_request_headers = 10;

getRetriableRequestHeaders

HeaderMatcher getRetriableRequestHeaders(int index)

 HTTP headers which must be present in the request for retries to be attempted.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_request_headers = 10;

getRetriableRequestHeadersCount

int getRetriableRequestHeadersCount()

 HTTP headers which must be present in the request for retries to be attempted.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_request_headers = 10;

getRetriableRequestHeadersOrBuilderList

List<? extends HeaderMatcherOrBuilder> getRetriableRequestHeadersOrBuilderList()

 HTTP headers which must be present in the request for retries to be attempted.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_request_headers = 10;

getRetriableRequestHeadersOrBuilder

HeaderMatcherOrBuilder getRetriableRequestHeadersOrBuilder(int index)

 HTTP headers which must be present in the request for retries to be attempted.
 

repeated .envoy.config.route.v4alpha.HeaderMatcher retriable_request_headers = 10;