Class RetryInfo (2.42.0)

public final class RetryInfo extends GeneratedMessageV3 implements RetryInfoOrBuilder

Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.

It's always recommended that clients should use exponential backoff when retrying.

Clients should wait until retry_delay amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retry_delay, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.

Protobuf type google.rpc.RetryInfo

Implements

RetryInfoOrBuilder

Static Fields

RETRY_DELAY_FIELD_NUMBER

public static final int RETRY_DELAY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetryInfo getDefaultInstance()
Returns
Type Description
RetryInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RetryInfo.Builder newBuilder()
Returns
Type Description
RetryInfo.Builder

newBuilder(RetryInfo prototype)

public static RetryInfo.Builder newBuilder(RetryInfo prototype)
Parameter
Name Description
prototype RetryInfo
Returns
Type Description
RetryInfo.Builder

parseDelimitedFrom(InputStream input)

public static RetryInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetryInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetryInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetryInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetryInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetryInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetryInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetryInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetryInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetryInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetryInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetryInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetryInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetryInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetryInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetryInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetryInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetryInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetryInfo> parser()
Returns
Type Description
Parser<RetryInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RetryInfo getDefaultInstanceForType()
Returns
Type Description
RetryInfo

getParserForType()

public Parser<RetryInfo> getParserForType()
Returns
Type Description
Parser<RetryInfo>
Overrides

getRetryDelay()

public Duration getRetryDelay()

Clients should wait at least this long between retrying the same request.

.google.protobuf.Duration retry_delay = 1;

Returns
Type Description
Duration

The retryDelay.

getRetryDelayOrBuilder()

public DurationOrBuilder getRetryDelayOrBuilder()

Clients should wait at least this long between retrying the same request.

.google.protobuf.Duration retry_delay = 1;

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRetryDelay()

public boolean hasRetryDelay()

Clients should wait at least this long between retrying the same request.

.google.protobuf.Duration retry_delay = 1;

Returns
Type Description
boolean

Whether the retryDelay field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RetryInfo.Builder newBuilderForType()
Returns
Type Description
RetryInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetryInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetryInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RetryInfo.Builder toBuilder()
Returns
Type Description
RetryInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException