Class HttpRetryPolicy (1.91.0)

Version latest

• 1.91.0 (latest)
• 1.90.0
• 1.88.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.80.0
• 1.78.0
• 1.77.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public final class HttpRetryPolicy extends GeneratedMessageV3 implements HttpRetryPolicyOrBuilder

The retry policy associates with HttpRouteRule

Protobuf type google.cloud.compute.v1.HttpRetryPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpRetryPolicy

Implements

HttpRetryPolicyOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

NUM_RETRIES_FIELD_NUMBER

public static final int NUM_RETRIES_FIELD_NUMBER

Field Value
Type	Description
int

PER_TRY_TIMEOUT_FIELD_NUMBER

public static final int PER_TRY_TIMEOUT_FIELD_NUMBER

Field Value
Type	Description
int

RETRY_CONDITIONS_FIELD_NUMBER

public static final int RETRY_CONDITIONS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static HttpRetryPolicy getDefaultInstance()

Returns
Type	Description
HttpRetryPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static HttpRetryPolicy.Builder newBuilder()

Returns
Type	Description
HttpRetryPolicy.Builder

newBuilder(HttpRetryPolicy prototype)

public static HttpRetryPolicy.Builder newBuilder(HttpRetryPolicy prototype)

Parameter
Name	Description
prototype	HttpRetryPolicy

Returns
Type	Description
HttpRetryPolicy.Builder

parseDelimitedFrom(InputStream input)

public static HttpRetryPolicy parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRetryPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static HttpRetryPolicy parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRetryPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRetryPolicy parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRetryPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRetryPolicy parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRetryPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static HttpRetryPolicy parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRetryPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static HttpRetryPolicy parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRetryPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpRetryPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<HttpRetryPolicy> parser()

Returns
Type	Description
Parser<HttpRetryPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public HttpRetryPolicy getDefaultInstanceForType()

Returns
Type	Description
HttpRetryPolicy

getNumRetries()

public int getNumRetries()

Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

optional uint32 num_retries = 251680141;

Returns
Type	Description
int	The numRetries.

getParserForType()

public Parser<HttpRetryPolicy> getParserForType()

Returns
Type	Description
Parser<HttpRetryPolicy>

Overrides

GeneratedMessageV3.getParserForType()

getPerTryTimeout()

public Duration getPerTryTimeout()

Specifies a non-zero timeout per retry attempt.

If not specified, will use the timeout set in theHttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route.

Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.Duration per_try_timeout = 280041147;

Returns
Type	Description
Duration	The perTryTimeout.

getPerTryTimeoutOrBuilder()

public DurationOrBuilder getPerTryTimeoutOrBuilder()

Specifies a non-zero timeout per retry attempt.

If not specified, will use the timeout set in theHttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route.

Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.Duration per_try_timeout = 280041147;

Returns
Type	Description
DurationOrBuilder

getRetryConditions(int index)

public String getRetryConditions(int index)

Specifies one or more conditions when this retry policy applies. Valid values are:

- 5xx: retry is attempted if the instance or endpoint
responds with any 5xx response code, or if the instance or
endpoint does not respond at all. For example, disconnects, reset, read
timeout, connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only
applies to response codes 502, 503 or504.
- connect-failure: a retry is attempted on failures
connecting to the instance or endpoint. For example, connection
timeouts.
- retriable-4xx: a retry is attempted if the instance
or endpoint responds with a 4xx response code.
The only error that you can retry is error code 409.
- refused-stream: a retry is attempted if the instance
or endpoint resets the stream with a REFUSED_STREAM error
code. This reset type indicates that it is safe to retry.
- cancelled: a retry is attempted if the gRPC status
code in the response header is set to cancelled.
- deadline-exceeded: a retry is attempted if the gRPC
status code in the response header is set todeadline-exceeded.
- internal: a retry is attempted if the gRPC
status code in the response header is set tointernal.
- resource-exhausted: a retry is attempted if the gRPC
status code in the response header is set toresource-exhausted.
- unavailable: a retry is attempted if the gRPC
status code in the response header is set tounavailable.

Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

- cancelled
- deadline-exceeded
- internal
- resource-exhausted
- unavailable

repeated string retry_conditions = 28815535;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The retryConditions at the given index.

getRetryConditionsBytes(int index)

public ByteString getRetryConditionsBytes(int index)

Specifies one or more conditions when this retry policy applies. Valid values are:

- 5xx: retry is attempted if the instance or endpoint
responds with any 5xx response code, or if the instance or
endpoint does not respond at all. For example, disconnects, reset, read
timeout, connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only
applies to response codes 502, 503 or504.
- connect-failure: a retry is attempted on failures
connecting to the instance or endpoint. For example, connection
timeouts.
- retriable-4xx: a retry is attempted if the instance
or endpoint responds with a 4xx response code.
The only error that you can retry is error code 409.
- refused-stream: a retry is attempted if the instance
or endpoint resets the stream with a REFUSED_STREAM error
code. This reset type indicates that it is safe to retry.
- cancelled: a retry is attempted if the gRPC status
code in the response header is set to cancelled.
- deadline-exceeded: a retry is attempted if the gRPC
status code in the response header is set todeadline-exceeded.
- internal: a retry is attempted if the gRPC
status code in the response header is set tointernal.
- resource-exhausted: a retry is attempted if the gRPC
status code in the response header is set toresource-exhausted.
- unavailable: a retry is attempted if the gRPC
status code in the response header is set tounavailable.

Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

- cancelled
- deadline-exceeded
- internal
- resource-exhausted
- unavailable

repeated string retry_conditions = 28815535;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the retryConditions at the given index.

getRetryConditionsCount()

public int getRetryConditionsCount()

Specifies one or more conditions when this retry policy applies. Valid values are:

- 5xx: retry is attempted if the instance or endpoint
responds with any 5xx response code, or if the instance or
endpoint does not respond at all. For example, disconnects, reset, read
timeout, connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only
applies to response codes 502, 503 or504.
- connect-failure: a retry is attempted on failures
connecting to the instance or endpoint. For example, connection
timeouts.
- retriable-4xx: a retry is attempted if the instance
or endpoint responds with a 4xx response code.
The only error that you can retry is error code 409.
- refused-stream: a retry is attempted if the instance
or endpoint resets the stream with a REFUSED_STREAM error
code. This reset type indicates that it is safe to retry.
- cancelled: a retry is attempted if the gRPC status
code in the response header is set to cancelled.
- deadline-exceeded: a retry is attempted if the gRPC
status code in the response header is set todeadline-exceeded.
- internal: a retry is attempted if the gRPC
status code in the response header is set tointernal.
- resource-exhausted: a retry is attempted if the gRPC
status code in the response header is set toresource-exhausted.
- unavailable: a retry is attempted if the gRPC
status code in the response header is set tounavailable.

Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

- cancelled
- deadline-exceeded
- internal
- resource-exhausted
- unavailable

repeated string retry_conditions = 28815535;

Returns
Type	Description
int	The count of retryConditions.

getRetryConditionsList()

public ProtocolStringList getRetryConditionsList()

Specifies one or more conditions when this retry policy applies. Valid values are:

- 5xx: retry is attempted if the instance or endpoint
responds with any 5xx response code, or if the instance or
endpoint does not respond at all. For example, disconnects, reset, read
timeout, connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only
applies to response codes 502, 503 or504.
- connect-failure: a retry is attempted on failures
connecting to the instance or endpoint. For example, connection
timeouts.
- retriable-4xx: a retry is attempted if the instance
or endpoint responds with a 4xx response code.
The only error that you can retry is error code 409.
- refused-stream: a retry is attempted if the instance
or endpoint resets the stream with a REFUSED_STREAM error
code. This reset type indicates that it is safe to retry.
- cancelled: a retry is attempted if the gRPC status
code in the response header is set to cancelled.
- deadline-exceeded: a retry is attempted if the gRPC
status code in the response header is set todeadline-exceeded.
- internal: a retry is attempted if the gRPC
status code in the response header is set tointernal.
- resource-exhausted: a retry is attempted if the gRPC
status code in the response header is set toresource-exhausted.
- unavailable: a retry is attempted if the gRPC
status code in the response header is set tounavailable.

Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

- cancelled
- deadline-exceeded
- internal
- resource-exhausted
- unavailable

repeated string retry_conditions = 28815535;

Returns
Type	Description
ProtocolStringList	A list containing the retryConditions.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasNumRetries()

public boolean hasNumRetries()

Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

optional uint32 num_retries = 251680141;

Returns
Type	Description
boolean	Whether the numRetries field is set.

hasPerTryTimeout()

public boolean hasPerTryTimeout()

Specifies a non-zero timeout per retry attempt.

If not specified, will use the timeout set in theHttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route.

Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.Duration per_try_timeout = 280041147;

Returns
Type	Description
boolean	Whether the perTryTimeout field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public HttpRetryPolicy.Builder newBuilderForType()

Returns
Type	Description
HttpRetryPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRetryPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
HttpRetryPolicy.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public HttpRetryPolicy.Builder toBuilder()

Returns
Type	Description
HttpRetryPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException