Class RetryInfo (2.9.1)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

Static Methods

getDefaultInstance()

public static RetryInfo getDefaultInstance()
Returns
TypeDescription
RetryInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RetryInfo.Builder newBuilder()
Returns
TypeDescription
RetryInfo.Builder

newBuilder(RetryInfo prototype)

public static RetryInfo.Builder newBuilder(RetryInfo prototype)
Parameter
NameDescription
prototypeRetryInfo
Returns
TypeDescription
RetryInfo.Builder

parseDelimitedFrom(InputStream input)

public static RetryInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RetryInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetryInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetryInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RetryInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RetryInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetryInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RetryInfo> parser()
Returns
TypeDescription
Parser<RetryInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RetryInfo getDefaultInstanceForType()
Returns
TypeDescription
RetryInfo

getParserForType()

public Parser<RetryInfo> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasRetryDelay()

public boolean hasRetryDelay()

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

.google.protobuf.Duration retry_delay = 1;

Returns
TypeDescription
boolean

Whether the retryDelay field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RetryInfo.Builder newBuilderForType()
Returns
TypeDescription
RetryInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetryInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RetryInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RetryInfo.Builder toBuilder()
Returns
TypeDescription
RetryInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException