Class RetryPolicy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.RetryPolicy
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RetryPolicyOrBuilder
,Serializable
public final class RetryPolicy
extends com.google.protobuf.GeneratedMessage
implements RetryPolicyOrBuilder
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`. [#next-free-field: 14]Protobuf type
envoy.config.route.v3.RetryPolicy
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.static final class
A retry back-off strategy that applies when the upstream server rate limits the request.static interface
static final class
Protobuf typeenvoy.config.route.v3.RetryPolicy.ResetHeader
static enum
Protobuf enumenvoy.config.route.v3.RetryPolicy.ResetHeaderFormat
static interface
static final class
Protobuf typeenvoy.config.route.v3.RetryPolicy.RetryBackOff
static interface
static final class
Protobuf typeenvoy.config.route.v3.RetryPolicy.RetryHostPredicate
static interface
static final class
Protobuf typeenvoy.config.route.v3.RetryPolicy.RetryPriority
static interface
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final RetryPolicy
static final int
private long
private byte
static final int
private com.google.protobuf.UInt32Value
private static final com.google.protobuf.Parser
<RetryPolicy> static final int
static final int
private com.google.protobuf.Duration
private com.google.protobuf.Duration
static final int
static final int
static final int
static final int
private List
<HeaderMatcher> private List
<HeaderMatcher> private com.google.protobuf.Internal.IntList
private int
static final int
static final int
static final int
static final int
static final int
private RetryPolicy.RetryBackOff
private List
<RetryPolicy.RetryHostPredicate> private Object
private List
<TypedExtensionConfig> private RetryPolicy.RetryPriority
private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
RetryPolicy
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static RetryPolicy
static final com.google.protobuf.Descriptors.Descriptor
long
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
Specifies the allowed number of retries.com.google.protobuf.UInt32ValueOrBuilder
Specifies the allowed number of retries.com.google.protobuf.Parser
<RetryPolicy> com.google.protobuf.Duration
Specifies an upstream idle timeout per retry attempt (including the initial attempt).com.google.protobuf.DurationOrBuilder
Specifies an upstream idle timeout per retry attempt (including the initial attempt).com.google.protobuf.Duration
Specifies a non-zero upstream timeout per retry attempt (including the initial attempt).com.google.protobuf.DurationOrBuilder
Specifies a non-zero upstream timeout per retry attempt (including the initial attempt).Specifies parameters that control a retry back-off strategy that is used when the request is rate limited by the upstream server.Specifies parameters that control a retry back-off strategy that is used when the request is rate limited by the upstream server.getRetriableHeaders
(int index) HTTP response headers that trigger a retry if present in the response.int
HTTP response headers that trigger a retry if present in the response.HTTP response headers that trigger a retry if present in the response.getRetriableHeadersOrBuilder
(int index) HTTP response headers that trigger a retry if present in the response.List
<? extends HeaderMatcherOrBuilder> HTTP response headers that trigger a retry if present in the response.getRetriableRequestHeaders
(int index) HTTP headers which must be present in the request for retries to be attempted.int
HTTP headers which must be present in the request for retries to be attempted.HTTP headers which must be present in the request for retries to be attempted.getRetriableRequestHeadersOrBuilder
(int index) HTTP headers which must be present in the request for retries to be attempted.List
<? extends HeaderMatcherOrBuilder> 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
HTTP status codes that should trigger a retry in addition to those specified by retry_on.HTTP status codes that should trigger a retry in addition to those specified by retry_on.Specifies parameters that control exponential retry back off.Specifies parameters that control exponential retry back off.getRetryHostPredicate
(int index) Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.int
Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.getRetryHostPredicateOrBuilder
(int index) Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.List
<? extends RetryPolicy.RetryHostPredicateOrBuilder> Specifies a collection of RetryHostPredicates that will be consulted when selecting a host for retries.Specifies the conditions under which retry takes place.com.google.protobuf.ByteString
Specifies the conditions under which retry takes place.getRetryOptionsPredicates
(int index) Retry options predicates that will be applied prior to retrying a request.int
Retry options predicates that will be applied prior to retrying a request.Retry options predicates that will be applied prior to retrying a request.getRetryOptionsPredicatesOrBuilder
(int index) Retry options predicates that will be applied prior to retrying a request.List
<? extends TypedExtensionConfigOrBuilder> Retry options predicates that will be applied prior to retrying a request.Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.int
int
hashCode()
boolean
Specifies the allowed number of retries.boolean
Specifies an upstream idle timeout per retry attempt (including the initial attempt).boolean
Specifies a non-zero upstream timeout per retry attempt (including the initial attempt).boolean
Specifies parameters that control a retry back-off strategy that is used when the request is rate limited by the upstream server.boolean
Specifies parameters that control exponential retry back off.boolean
Specifies an implementation of a RetryPriority which is used to determine the distribution of load across priorities used for retries.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static RetryPolicy.Builder
static RetryPolicy.Builder
newBuilder
(RetryPolicy prototype) protected RetryPolicy.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static RetryPolicy
parseDelimitedFrom
(InputStream input) static RetryPolicy
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RetryPolicy
parseFrom
(byte[] data) static RetryPolicy
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RetryPolicy
parseFrom
(com.google.protobuf.ByteString data) static RetryPolicy
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RetryPolicy
parseFrom
(com.google.protobuf.CodedInputStream input) static RetryPolicy
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RetryPolicy
parseFrom
(InputStream input) static RetryPolicy
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RetryPolicy
parseFrom
(ByteBuffer data) static RetryPolicy
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<RetryPolicy> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
RETRY_ON_FIELD_NUMBER
public static final int RETRY_ON_FIELD_NUMBER- See Also:
-
retryOn_
-
NUM_RETRIES_FIELD_NUMBER
public static final int NUM_RETRIES_FIELD_NUMBER- See Also:
-
numRetries_
private com.google.protobuf.UInt32Value numRetries_ -
PER_TRY_TIMEOUT_FIELD_NUMBER
public static final int PER_TRY_TIMEOUT_FIELD_NUMBER- See Also:
-
perTryTimeout_
private com.google.protobuf.Duration perTryTimeout_ -
PER_TRY_IDLE_TIMEOUT_FIELD_NUMBER
public static final int PER_TRY_IDLE_TIMEOUT_FIELD_NUMBER- See Also:
-
perTryIdleTimeout_
private com.google.protobuf.Duration perTryIdleTimeout_ -
RETRY_PRIORITY_FIELD_NUMBER
public static final int RETRY_PRIORITY_FIELD_NUMBER- See Also:
-
retryPriority_
-
RETRY_HOST_PREDICATE_FIELD_NUMBER
public static final int RETRY_HOST_PREDICATE_FIELD_NUMBER- See Also:
-
retryHostPredicate_
-
RETRY_OPTIONS_PREDICATES_FIELD_NUMBER
public static final int RETRY_OPTIONS_PREDICATES_FIELD_NUMBER- See Also:
-
retryOptionsPredicates_
-
HOST_SELECTION_RETRY_MAX_ATTEMPTS_FIELD_NUMBER
public static final int HOST_SELECTION_RETRY_MAX_ATTEMPTS_FIELD_NUMBER- See Also:
-
hostSelectionRetryMaxAttempts_
private long hostSelectionRetryMaxAttempts_ -
RETRIABLE_STATUS_CODES_FIELD_NUMBER
public static final int RETRIABLE_STATUS_CODES_FIELD_NUMBER- See Also:
-
retriableStatusCodes_
private com.google.protobuf.Internal.IntList retriableStatusCodes_ -
retriableStatusCodesMemoizedSerializedSize
private int retriableStatusCodesMemoizedSerializedSize -
RETRY_BACK_OFF_FIELD_NUMBER
public static final int RETRY_BACK_OFF_FIELD_NUMBER- See Also:
-
retryBackOff_
-
RATE_LIMITED_RETRY_BACK_OFF_FIELD_NUMBER
public static final int RATE_LIMITED_RETRY_BACK_OFF_FIELD_NUMBER- See Also:
-
rateLimitedRetryBackOff_
-
RETRIABLE_HEADERS_FIELD_NUMBER
public static final int RETRIABLE_HEADERS_FIELD_NUMBER- See Also:
-
retriableHeaders_
-
RETRIABLE_REQUEST_HEADERS_FIELD_NUMBER
public static final int RETRIABLE_REQUEST_HEADERS_FIELD_NUMBER- See Also:
-
retriableRequestHeaders_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
RetryPolicy
private RetryPolicy(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
RetryPolicy
private RetryPolicy()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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;
- Specified by:
getRetryOn
in interfaceRetryPolicyOrBuilder
- Returns:
- The retryOn.
-
getRetryOnBytes
public 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;
- Specified by:
getRetryOnBytes
in interfaceRetryPolicyOrBuilder
- Returns:
- The bytes for retryOn.
-
hasNumRetries
public 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 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
hasNumRetries
in interfaceRetryPolicyOrBuilder
- Returns:
- Whether the numRetries field is set.
-
getNumRetries
public 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 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getNumRetries
in interfaceRetryPolicyOrBuilder
- Returns:
- The numRetries.
-
getNumRetriesOrBuilder
public 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 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getNumRetriesOrBuilder
in interfaceRetryPolicyOrBuilder
-
hasPerTryTimeout
public boolean hasPerTryTimeout()Specifies a non-zero upstream timeout per retry attempt (including the initial 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_v3_api_field_config.route.v3.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;
- Specified by:
hasPerTryTimeout
in interfaceRetryPolicyOrBuilder
- Returns:
- Whether the perTryTimeout field is set.
-
getPerTryTimeout
public com.google.protobuf.Duration getPerTryTimeout()Specifies a non-zero upstream timeout per retry attempt (including the initial 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_v3_api_field_config.route.v3.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;
- Specified by:
getPerTryTimeout
in interfaceRetryPolicyOrBuilder
- Returns:
- The perTryTimeout.
-
getPerTryTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getPerTryTimeoutOrBuilder()Specifies a non-zero upstream timeout per retry attempt (including the initial 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_v3_api_field_config.route.v3.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;
- Specified by:
getPerTryTimeoutOrBuilder
in interfaceRetryPolicyOrBuilder
-
hasPerTryIdleTimeout
public boolean hasPerTryIdleTimeout()Specifies an upstream idle timeout per retry attempt (including the initial attempt). This parameter is optional and if absent there is no per try idle timeout. The semantics of the per try idle timeout are similar to the :ref:`route idle timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` and :ref:`stream idle timeout <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>` both enforced by the HTTP connection manager. The difference is that this idle timeout is enforced by the router for each individual attempt and thus after all previous filters have run, as opposed to *before* all previous filters run for the other idle timeouts. This timeout is useful in cases in which total request timeout is bounded by a number of retries and a :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, but there is a desire to ensure each try is making incremental progress. Note also that similar to :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, this idle timeout does not start until after both the entire request has been received by the router *and* a connection pool connection has been obtained. Unlike :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, the idle timer continues once the response starts streaming back to the downstream client. This ensures that response data continues to make progress without using one of the HTTP connection manager idle timeouts.
.google.protobuf.Duration per_try_idle_timeout = 13;
- Specified by:
hasPerTryIdleTimeout
in interfaceRetryPolicyOrBuilder
- Returns:
- Whether the perTryIdleTimeout field is set.
-
getPerTryIdleTimeout
public com.google.protobuf.Duration getPerTryIdleTimeout()Specifies an upstream idle timeout per retry attempt (including the initial attempt). This parameter is optional and if absent there is no per try idle timeout. The semantics of the per try idle timeout are similar to the :ref:`route idle timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` and :ref:`stream idle timeout <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>` both enforced by the HTTP connection manager. The difference is that this idle timeout is enforced by the router for each individual attempt and thus after all previous filters have run, as opposed to *before* all previous filters run for the other idle timeouts. This timeout is useful in cases in which total request timeout is bounded by a number of retries and a :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, but there is a desire to ensure each try is making incremental progress. Note also that similar to :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, this idle timeout does not start until after both the entire request has been received by the router *and* a connection pool connection has been obtained. Unlike :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, the idle timer continues once the response starts streaming back to the downstream client. This ensures that response data continues to make progress without using one of the HTTP connection manager idle timeouts.
.google.protobuf.Duration per_try_idle_timeout = 13;
- Specified by:
getPerTryIdleTimeout
in interfaceRetryPolicyOrBuilder
- Returns:
- The perTryIdleTimeout.
-
getPerTryIdleTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getPerTryIdleTimeoutOrBuilder()Specifies an upstream idle timeout per retry attempt (including the initial attempt). This parameter is optional and if absent there is no per try idle timeout. The semantics of the per try idle timeout are similar to the :ref:`route idle timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` and :ref:`stream idle timeout <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>` both enforced by the HTTP connection manager. The difference is that this idle timeout is enforced by the router for each individual attempt and thus after all previous filters have run, as opposed to *before* all previous filters run for the other idle timeouts. This timeout is useful in cases in which total request timeout is bounded by a number of retries and a :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, but there is a desire to ensure each try is making incremental progress. Note also that similar to :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, this idle timeout does not start until after both the entire request has been received by the router *and* a connection pool connection has been obtained. Unlike :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, the idle timer continues once the response starts streaming back to the downstream client. This ensures that response data continues to make progress without using one of the HTTP connection manager idle timeouts.
.google.protobuf.Duration per_try_idle_timeout = 13;
- Specified by:
getPerTryIdleTimeoutOrBuilder
in interfaceRetryPolicyOrBuilder
-
hasRetryPriority
public 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.v3.RetryPolicy.RetryPriority retry_priority = 4;
- Specified by:
hasRetryPriority
in interfaceRetryPolicyOrBuilder
- Returns:
- Whether the retryPriority field is set.
-
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.v3.RetryPolicy.RetryPriority retry_priority = 4;
- Specified by:
getRetryPriority
in interfaceRetryPolicyOrBuilder
- Returns:
- The retryPriority.
-
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.v3.RetryPolicy.RetryPriority retry_priority = 4;
- Specified by:
getRetryPriorityOrBuilder
in interfaceRetryPolicyOrBuilder
-
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.v3.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;
- Specified by:
getRetryHostPredicateList
in interfaceRetryPolicyOrBuilder
-
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.v3.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;
- Specified by:
getRetryHostPredicateOrBuilderList
in interfaceRetryPolicyOrBuilder
-
getRetryHostPredicateCount
public 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.v3.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;
- Specified by:
getRetryHostPredicateCount
in interfaceRetryPolicyOrBuilder
-
getRetryHostPredicate
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.v3.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;
- Specified by:
getRetryHostPredicate
in interfaceRetryPolicyOrBuilder
-
getRetryHostPredicateOrBuilder
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.v3.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;
- Specified by:
getRetryHostPredicateOrBuilder
in interfaceRetryPolicyOrBuilder
-
getRetryOptionsPredicatesList
Retry options predicates that will be applied prior to retrying a request. These predicates allow customizing request behavior between retries. [#comment: add [#extension-category: envoy.retry_options_predicates] when there are built-in extensions]
repeated .envoy.config.core.v3.TypedExtensionConfig retry_options_predicates = 12;
- Specified by:
getRetryOptionsPredicatesList
in interfaceRetryPolicyOrBuilder
-
getRetryOptionsPredicatesOrBuilderList
Retry options predicates that will be applied prior to retrying a request. These predicates allow customizing request behavior between retries. [#comment: add [#extension-category: envoy.retry_options_predicates] when there are built-in extensions]
repeated .envoy.config.core.v3.TypedExtensionConfig retry_options_predicates = 12;
- Specified by:
getRetryOptionsPredicatesOrBuilderList
in interfaceRetryPolicyOrBuilder
-
getRetryOptionsPredicatesCount
public int getRetryOptionsPredicatesCount()Retry options predicates that will be applied prior to retrying a request. These predicates allow customizing request behavior between retries. [#comment: add [#extension-category: envoy.retry_options_predicates] when there are built-in extensions]
repeated .envoy.config.core.v3.TypedExtensionConfig retry_options_predicates = 12;
- Specified by:
getRetryOptionsPredicatesCount
in interfaceRetryPolicyOrBuilder
-
getRetryOptionsPredicates
Retry options predicates that will be applied prior to retrying a request. These predicates allow customizing request behavior between retries. [#comment: add [#extension-category: envoy.retry_options_predicates] when there are built-in extensions]
repeated .envoy.config.core.v3.TypedExtensionConfig retry_options_predicates = 12;
- Specified by:
getRetryOptionsPredicates
in interfaceRetryPolicyOrBuilder
-
getRetryOptionsPredicatesOrBuilder
Retry options predicates that will be applied prior to retrying a request. These predicates allow customizing request behavior between retries. [#comment: add [#extension-category: envoy.retry_options_predicates] when there are built-in extensions]
repeated .envoy.config.core.v3.TypedExtensionConfig retry_options_predicates = 12;
- Specified by:
getRetryOptionsPredicatesOrBuilder
in interfaceRetryPolicyOrBuilder
-
getHostSelectionRetryMaxAttempts
public 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;
- Specified by:
getHostSelectionRetryMaxAttempts
in interfaceRetryPolicyOrBuilder
- Returns:
- The hostSelectionRetryMaxAttempts.
-
getRetriableStatusCodesList
HTTP status codes that should trigger a retry in addition to those specified by retry_on.
repeated uint32 retriable_status_codes = 7;
- Specified by:
getRetriableStatusCodesList
in interfaceRetryPolicyOrBuilder
- Returns:
- A list containing the retriableStatusCodes.
-
getRetriableStatusCodesCount
public int getRetriableStatusCodesCount()HTTP status codes that should trigger a retry in addition to those specified by retry_on.
repeated uint32 retriable_status_codes = 7;
- Specified by:
getRetriableStatusCodesCount
in interfaceRetryPolicyOrBuilder
- Returns:
- The count of retriableStatusCodes.
-
getRetriableStatusCodes
public 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;
- Specified by:
getRetriableStatusCodes
in interfaceRetryPolicyOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The retriableStatusCodes at the given index.
-
hasRetryBackOff
public 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.v3.RetryPolicy.RetryBackOff retry_back_off = 8;
- Specified by:
hasRetryBackOff
in interfaceRetryPolicyOrBuilder
- Returns:
- Whether the retryBackOff field is set.
-
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.v3.RetryPolicy.RetryBackOff retry_back_off = 8;
- Specified by:
getRetryBackOff
in interfaceRetryPolicyOrBuilder
- Returns:
- The retryBackOff.
-
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.v3.RetryPolicy.RetryBackOff retry_back_off = 8;
- Specified by:
getRetryBackOffOrBuilder
in interfaceRetryPolicyOrBuilder
-
hasRateLimitedRetryBackOff
public 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.v3.RetryPolicy.RateLimitedRetryBackOff rate_limited_retry_back_off = 11;
- Specified by:
hasRateLimitedRetryBackOff
in interfaceRetryPolicyOrBuilder
- Returns:
- Whether the rateLimitedRetryBackOff field is set.
-
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.v3.RetryPolicy.RateLimitedRetryBackOff rate_limited_retry_back_off = 11;
- Specified by:
getRateLimitedRetryBackOff
in interfaceRetryPolicyOrBuilder
- Returns:
- The rateLimitedRetryBackOff.
-
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.v3.RetryPolicy.RateLimitedRetryBackOff rate_limited_retry_back_off = 11;
- Specified by:
getRateLimitedRetryBackOffOrBuilder
in interfaceRetryPolicyOrBuilder
-
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.v3.HeaderMatcher retriable_headers = 9;
- Specified by:
getRetriableHeadersList
in interfaceRetryPolicyOrBuilder
-
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.v3.HeaderMatcher retriable_headers = 9;
- Specified by:
getRetriableHeadersOrBuilderList
in interfaceRetryPolicyOrBuilder
-
getRetriableHeadersCount
public 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.v3.HeaderMatcher retriable_headers = 9;
- Specified by:
getRetriableHeadersCount
in interfaceRetryPolicyOrBuilder
-
getRetriableHeaders
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.v3.HeaderMatcher retriable_headers = 9;
- Specified by:
getRetriableHeaders
in interfaceRetryPolicyOrBuilder
-
getRetriableHeadersOrBuilder
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.v3.HeaderMatcher retriable_headers = 9;
- Specified by:
getRetriableHeadersOrBuilder
in interfaceRetryPolicyOrBuilder
-
getRetriableRequestHeadersList
HTTP headers which must be present in the request for retries to be attempted.
repeated .envoy.config.route.v3.HeaderMatcher retriable_request_headers = 10;
- Specified by:
getRetriableRequestHeadersList
in interfaceRetryPolicyOrBuilder
-
getRetriableRequestHeadersOrBuilderList
HTTP headers which must be present in the request for retries to be attempted.
repeated .envoy.config.route.v3.HeaderMatcher retriable_request_headers = 10;
- Specified by:
getRetriableRequestHeadersOrBuilderList
in interfaceRetryPolicyOrBuilder
-
getRetriableRequestHeadersCount
public int getRetriableRequestHeadersCount()HTTP headers which must be present in the request for retries to be attempted.
repeated .envoy.config.route.v3.HeaderMatcher retriable_request_headers = 10;
- Specified by:
getRetriableRequestHeadersCount
in interfaceRetryPolicyOrBuilder
-
getRetriableRequestHeaders
HTTP headers which must be present in the request for retries to be attempted.
repeated .envoy.config.route.v3.HeaderMatcher retriable_request_headers = 10;
- Specified by:
getRetriableRequestHeaders
in interfaceRetryPolicyOrBuilder
-
getRetriableRequestHeadersOrBuilder
HTTP headers which must be present in the request for retries to be attempted.
repeated .envoy.config.route.v3.HeaderMatcher retriable_request_headers = 10;
- Specified by:
getRetriableRequestHeadersOrBuilder
in interfaceRetryPolicyOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RetryPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RetryPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RetryPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RetryPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RetryPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RetryPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RetryPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static RetryPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RetryPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RetryPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-