envoy.api.v2.route

Interface RouteOuterClass.RouteAction.RetryPolicyOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RouteOuterClass.RouteAction.RetryPolicy, RouteOuterClass.RouteAction.RetryPolicy.Builder

Enclosing class:

RouteOuterClass.RouteAction

public static interface RouteOuterClass.RouteAction.RetryPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
long	getHostSelectionRetryMaxAttempts() [#not-implemented-hide:] 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	getNumRetries() Specifies the allowed number of retries.
com.google.protobuf.UInt32ValueOrBuilder	getNumRetriesOrBuilder() 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.
RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicate	getRetryHostPredicate(int index) [#not-implemented-hide:] Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
int	getRetryHostPredicateCount() [#not-implemented-hide:] Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
List<RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicate>	getRetryHostPredicateList() [#not-implemented-hide:] Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicateOrBuilder	getRetryHostPredicateOrBuilder(int index) [#not-implemented-hide:] Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.
List<? extends RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicateOrBuilder>	getRetryHostPredicateOrBuilderList() [#not-implemented-hide:] 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.
RouteOuterClass.RouteAction.RetryPolicy.RetryPriority	getRetryPriority() [#not-implemented-hide:] Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.
RouteOuterClass.RouteAction.RetryPolicy.RetryPriorityOrBuilder	getRetryPriorityOrBuilder() [#not-implemented-hide:] Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.
boolean	hasNumRetries() Specifies the allowed number of retries.
boolean	hasPerTryTimeout() Specifies a non-zero upstream timeout per retry attempt.
boolean	hasRetryPriority() [#not-implemented-hide:] 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;

hasNumRetries

boolean hasNumRetries()

 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 num_retries = 2;

getNumRetries

com.google.protobuf.UInt32Value getNumRetries()

 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 num_retries = 2;

getNumRetriesOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getNumRetriesOrBuilder()

 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 num_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_route.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 [(.gogoproto.stdduration) = true];

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_route.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 [(.gogoproto.stdduration) = true];

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_route.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 [(.gogoproto.stdduration) = true];

hasRetryPriority

boolean hasRetryPriority()

 [#not-implemented-hide:]
 Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries.
 

.envoy.api.v2.route.RouteAction.RetryPolicy.RetryPriority retry_priority = 4;

getRetryPriority

RouteOuterClass.RouteAction.RetryPolicy.RetryPriority getRetryPriority()

 [#not-implemented-hide:]
 Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries.
 

.envoy.api.v2.route.RouteAction.RetryPolicy.RetryPriority retry_priority = 4;

getRetryPriorityOrBuilder

RouteOuterClass.RouteAction.RetryPolicy.RetryPriorityOrBuilder getRetryPriorityOrBuilder()

 [#not-implemented-hide:]
 Specifies an implementation of a RetryPriority which is used to determine the
 distribution of load across priorities used for retries.
 

.envoy.api.v2.route.RouteAction.RetryPolicy.RetryPriority retry_priority = 4;

getRetryHostPredicateList

List<RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicate> getRetryHostPredicateList()

 [#not-implemented-hide:]
 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.
 

repeated .envoy.api.v2.route.RouteAction.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicate

RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicate getRetryHostPredicate(int index)

 [#not-implemented-hide:]
 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.
 

repeated .envoy.api.v2.route.RouteAction.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicateCount

int getRetryHostPredicateCount()

 [#not-implemented-hide:]
 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.
 

repeated .envoy.api.v2.route.RouteAction.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicateOrBuilderList

List<? extends RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicateOrBuilder> getRetryHostPredicateOrBuilderList()

 [#not-implemented-hide:]
 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.
 

repeated .envoy.api.v2.route.RouteAction.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getRetryHostPredicateOrBuilder

RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicateOrBuilder getRetryHostPredicateOrBuilder(int index)

 [#not-implemented-hide:]
 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.
 

repeated .envoy.api.v2.route.RouteAction.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;

getHostSelectionRetryMaxAttempts

long getHostSelectionRetryMaxAttempts()

 [#not-implemented-hide:]
 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;