Class RetryInfo (2.15.0)

public sealed class RetryInfo : IMessage<RetryInfo>, IEquatable<RetryInfo>, IDeepCloneable<RetryInfo>, IBufferMessage, IMessage

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.

Inheritance

object > RetryInfo

Implements

IMessage RetryInfo, IEquatable RetryInfo, IDeepCloneable RetryInfo, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

RetryInfo()

public RetryInfo()

RetryInfo(RetryInfo)

public RetryInfo(RetryInfo other)

Parameter
Name	Description
`other`	`RetryInfo`

Fields

RetryDelayFieldNumber

public const int RetryDelayFieldNumber = 1

Field number for the "retry_delay" field.

Field Value
Type	Description
`int`

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Parser

public static MessageParser<RetryInfo> Parser { get; }

Property Value
Type	Description
`MessageParserRetryInfo`

RetryDelay

public Duration RetryDelay { get; set; }

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

Property Value
Type	Description
`Duration`

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
`int`	The number of bytes required to write this message to a coded output stream.

Clone()

public RetryInfo Clone()

Creates a deep clone of this object.

Returns
Type	Description
`RetryInfo`	A deep clone of this object.

Equals(RetryInfo)

public bool Equals(RetryInfo other)

Parameter
Name	Description
`other`	`RetryInfo`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
`input`	`CodedInputStream`

Remarks

See the user guide for precise merge semantics.

MergeFrom(RetryInfo)

public void MergeFrom(RetryInfo other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`RetryInfo`

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
`output`	`CodedOutputStream` Coded output stream to write the data to. Must not be null.