RetryPolicy (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - 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.GeneratedMessageV3
implements RetryPolicyOrBuilder
```
```
 HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
 [#next-free-field: 12]
 
```
Protobuf type envoy.config.route.v3.RetryPolicy
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RetryPolicy.Builder` HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
`static class`	`RetryPolicy.RateLimitedRetryBackOff` A retry back-off strategy that applies when the upstream server rate limits the request.
`static interface`	`RetryPolicy.RateLimitedRetryBackOffOrBuilder`
`static class`	`RetryPolicy.ResetHeader` Protobuf type `envoy.config.route.v3.RetryPolicy.ResetHeader`
`static class`	`RetryPolicy.ResetHeaderFormat` Protobuf enum `envoy.config.route.v3.RetryPolicy.ResetHeaderFormat`
`static interface`	`RetryPolicy.ResetHeaderOrBuilder`
`static class`	`RetryPolicy.RetryBackOff` Protobuf type `envoy.config.route.v3.RetryPolicy.RetryBackOff`
`static interface`	`RetryPolicy.RetryBackOffOrBuilder`
`static class`	`RetryPolicy.RetryHostPredicate` Protobuf type `envoy.config.route.v3.RetryPolicy.RetryHostPredicate`
`static interface`	`RetryPolicy.RetryHostPredicateOrBuilder`
`static class`	`RetryPolicy.RetryPriority` Protobuf type `envoy.config.route.v3.RetryPolicy.RetryPriority`
`static interface`	`RetryPolicy.RetryPriorityOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`HOST_SELECTION_RETRY_MAX_ATTEMPTS_FIELD_NUMBER`
`static int`	`NUM_RETRIES_FIELD_NUMBER`
`static int`	`PER_TRY_TIMEOUT_FIELD_NUMBER`
`static int`	`RATE_LIMITED_RETRY_BACK_OFF_FIELD_NUMBER`
`static int`	`RETRIABLE_HEADERS_FIELD_NUMBER`
`static int`	`RETRIABLE_REQUEST_HEADERS_FIELD_NUMBER`
`static int`	`RETRIABLE_STATUS_CODES_FIELD_NUMBER`
`static int`	`RETRY_BACK_OFF_FIELD_NUMBER`
`static int`	`RETRY_HOST_PREDICATE_FIELD_NUMBER`
`static int`	`RETRY_ON_FIELD_NUMBER`
`static int`	`RETRY_PRIORITY_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static RetryPolicy`	`getDefaultInstance()`
`RetryPolicy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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`	`getNumRetries()` Specifies the allowed number of retries.
`com.google.protobuf.UInt32ValueOrBuilder`	`getNumRetriesOrBuilder()` Specifies the allowed number of retries.
`com.google.protobuf.Parser<RetryPolicy>`	`getParserForType()`
`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.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasNumRetries()` 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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static RetryPolicy.Builder`	`newBuilder()`
`static RetryPolicy.Builder`	`newBuilder(RetryPolicy prototype)`
`RetryPolicy.Builder`	`newBuilderForType()`
`protected RetryPolicy.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`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(ByteBuffer data)`
`static RetryPolicy`	`parseFrom(ByteBuffer 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 com.google.protobuf.Parser<RetryPolicy>`	`parser()`
`RetryPolicy.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- RETRY_ON_FIELD_NUMBER
```
public static final int RETRY_ON_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_RETRIES_FIELD_NUMBER
```
public static final int NUM_RETRIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PER_TRY_TIMEOUT_FIELD_NUMBER
```
public static final int PER_TRY_TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRY_PRIORITY_FIELD_NUMBER
```
public static final int RETRY_PRIORITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRY_HOST_PREDICATE_FIELD_NUMBER
```
public static final int RETRY_HOST_PREDICATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HOST_SELECTION_RETRY_MAX_ATTEMPTS_FIELD_NUMBER
```
public static final int HOST_SELECTION_RETRY_MAX_ATTEMPTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRIABLE_STATUS_CODES_FIELD_NUMBER
```
public static final int RETRIABLE_STATUS_CODES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRY_BACK_OFF_FIELD_NUMBER
```
public static final int RETRY_BACK_OFF_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RATE_LIMITED_RETRY_BACK_OFF_FIELD_NUMBER
```
public static final int RATE_LIMITED_RETRY_BACK_OFF_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRIABLE_HEADERS_FIELD_NUMBER
```
public static final int RETRIABLE_HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRIABLE_REQUEST_HEADERS_FIELD_NUMBER
```
public static final int RETRIABLE_REQUEST_HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getRetryOn

public 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;

Specified by:: getRetryOn in interface RetryPolicyOrBuilder

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 interface RetryPolicyOrBuilder

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 interface RetryPolicyOrBuilder

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 interface RetryPolicyOrBuilder

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 interface RetryPolicyOrBuilder

hasPerTryTimeout

public 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.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 interface RetryPolicyOrBuilder

getPerTryTimeout

public 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.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 interface RetryPolicyOrBuilder

getPerTryTimeoutOrBuilder

public 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.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 interface RetryPolicyOrBuilder

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 interface RetryPolicyOrBuilder

getRetryPriority

public 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.v3.RetryPolicy.RetryPriority retry_priority = 4;

Specified by:: getRetryPriority in interface RetryPolicyOrBuilder

getRetryPriorityOrBuilder

public 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.v3.RetryPolicy.RetryPriority retry_priority = 4;

Specified by:: getRetryPriorityOrBuilder in interface RetryPolicyOrBuilder