RouteOuterClass.RouteAction.RetryPolicy (api 0.1.11 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - envoy.api.v2.route.RouteOuterClass.RouteAction.RetryPolicy

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteOuterClass.RouteAction.RetryPolicyOrBuilder, Serializable

Enclosing class:

RouteOuterClass.RouteAction
```
public static final class RouteOuterClass.RouteAction.RetryPolicy
extends com.google.protobuf.GeneratedMessageV3
implements RouteOuterClass.RouteAction.RetryPolicyOrBuilder
```
```
 HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
 
```
Protobuf type envoy.api.v2.route.RouteAction.RetryPolicy
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RouteOuterClass.RouteAction.RetryPolicy.Builder` HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
`static class`	`RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicate` Protobuf type `envoy.api.v2.route.RouteAction.RetryPolicy.RetryHostPredicate`
`static interface`	`RouteOuterClass.RouteAction.RetryPolicy.RetryHostPredicateOrBuilder`
`static class`	`RouteOuterClass.RouteAction.RetryPolicy.RetryPriority` Protobuf type `envoy.api.v2.route.RouteAction.RetryPolicy.RetryPriority`
`static interface`	`RouteOuterClass.RouteAction.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

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`	`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 RouteOuterClass.RouteAction.RetryPolicy`	`getDefaultInstance()`
`RouteOuterClass.RouteAction.RetryPolicy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.Parser<RouteOuterClass.RouteAction.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.
`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.
`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`	`hasRetryPriority()` [#not-implemented-hide:] 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 RouteOuterClass.RouteAction.RetryPolicy.Builder`	`newBuilder()`
`static RouteOuterClass.RouteAction.RetryPolicy.Builder`	`newBuilder(RouteOuterClass.RouteAction.RetryPolicy prototype)`
`RouteOuterClass.RouteAction.RetryPolicy.Builder`	`newBuilderForType()`
`protected RouteOuterClass.RouteAction.RetryPolicy.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseDelimitedFrom(InputStream input)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(byte[] data)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(ByteBuffer data)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(com.google.protobuf.ByteString data)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(InputStream input)`
`static RouteOuterClass.RouteAction.RetryPolicy`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RouteOuterClass.RouteAction.RetryPolicy>`	`parser()`
`RouteOuterClass.RouteAction.RetryPolicy.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

Method Detail

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 RouteOuterClass.RouteAction.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 RouteOuterClass.RouteAction.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;

Specified by:: hasNumRetries in interface RouteOuterClass.RouteAction.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;

Specified by:: getNumRetries in interface RouteOuterClass.RouteAction.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;

Specified by:: getNumRetriesOrBuilder in interface RouteOuterClass.RouteAction.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_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];

Specified by:: hasPerTryTimeout in interface RouteOuterClass.RouteAction.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_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];

Specified by:: getPerTryTimeout in interface RouteOuterClass.RouteAction.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_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];

Specified by:: getPerTryTimeoutOrBuilder in interface RouteOuterClass.RouteAction.RetryPolicyOrBuilder

hasRetryPriority

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

Specified by:: hasRetryPriority in interface RouteOuterClass.RouteAction.RetryPolicyOrBuilder

getRetryPriority

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

Specified by:: getRetryPriority in interface RouteOuterClass.RouteAction.RetryPolicyOrBuilder

getRetryPriorityOrBuilder

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

Specified by:: getRetryPriorityOrBuilder in interface RouteOuterClass.RouteAction.RetryPolicyOrBuilder