public final class RetryPolicy extends com.google.protobuf.GeneratedMessageV3 implements RetryPolicyOrBuilder
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.Protobuf type
envoy.api.v2.route.RetryPolicy| Modifier and Type | Class and Description |
|---|---|
static class |
RetryPolicy.Builder
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
|
static class |
RetryPolicy.RetryHostPredicate
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryHostPredicate |
static interface |
RetryPolicy.RetryHostPredicateOrBuilder |
static class |
RetryPolicy.RetryPriority
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryPriority |
static interface |
RetryPolicy.RetryPriorityOrBuilder |
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| 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 |
RETRIABLE_STATUS_CODES_FIELD_NUMBER |
static int |
RETRY_HOST_PREDICATE_FIELD_NUMBER |
static int |
RETRY_ON_FIELD_NUMBER |
static int |
RETRY_PRIORITY_FIELD_NUMBER |
| 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.
|
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.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 |
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) |
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) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int RETRY_ON_FIELD_NUMBER
public static final int NUM_RETRIES_FIELD_NUMBER
public static final int PER_TRY_TIMEOUT_FIELD_NUMBER
public static final int RETRY_PRIORITY_FIELD_NUMBER
public static final int RETRY_HOST_PREDICATE_FIELD_NUMBER
public static final int HOST_SELECTION_RETRY_MAX_ATTEMPTS_FIELD_NUMBER
public static final int RETRIABLE_STATUS_CODES_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;getRetryOn in interface RetryPolicyOrBuilderpublic 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;getRetryOnBytes in interface RetryPolicyOrBuilderpublic 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;hasNumRetries in interface RetryPolicyOrBuilderpublic 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;getNumRetries in interface RetryPolicyOrBuilderpublic 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;getNumRetriesOrBuilder in interface RetryPolicyOrBuilderpublic 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];hasPerTryTimeout in interface RetryPolicyOrBuilderpublic 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];getPerTryTimeout in interface RetryPolicyOrBuilderpublic 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];getPerTryTimeoutOrBuilder in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryPriority retry_priority = 4;hasRetryPriority in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryPriority retry_priority = 4;getRetryPriority in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryPriority retry_priority = 4;getRetryPriorityOrBuilder in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;getRetryHostPredicateList in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;getRetryHostPredicateOrBuilderList in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;getRetryHostPredicateCount in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;getRetryHostPredicate in interface RetryPolicyOrBuilderpublic 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.api.v2.route.RetryPolicy.RetryHostPredicate retry_host_predicate = 5;getRetryHostPredicateOrBuilder in interface RetryPolicyOrBuilderpublic 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;getHostSelectionRetryMaxAttempts in interface RetryPolicyOrBuilderpublic 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;getRetriableStatusCodesList in interface RetryPolicyOrBuilderpublic int getRetriableStatusCodesCount()
HTTP status codes that should trigger a retry in addition to those specified by retry_on.
repeated uint32 retriable_status_codes = 7;getRetriableStatusCodesCount in interface RetryPolicyOrBuilderpublic 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;getRetriableStatusCodes in interface RetryPolicyOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RetryPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryPolicy parseFrom(InputStream input) throws IOException
IOExceptionpublic static RetryPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RetryPolicy parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RetryPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RetryPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RetryPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RetryPolicy.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RetryPolicy.Builder newBuilder()
public static RetryPolicy.Builder newBuilder(RetryPolicy prototype)
public RetryPolicy.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RetryPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RetryPolicy getDefaultInstance()
public static com.google.protobuf.Parser<RetryPolicy> parser()
public com.google.protobuf.Parser<RetryPolicy> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RetryPolicy getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2019 The Envoy Project. All rights reserved.