public static final class RetryInfo.Builder extends GeneratedMessageV3.Builder<RetryInfo.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RetryInfo.BuilderImplements
RetryInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RetryInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
build()
public RetryInfo build()
Returns | |
---|---|
Type | Description |
RetryInfo |
buildPartial()
public RetryInfo buildPartial()
Returns | |
---|---|
Type | Description |
RetryInfo |
clear()
public RetryInfo.Builder clear()
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
clearField(Descriptors.FieldDescriptor field)
public RetryInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RetryInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
clearRetryDelay()
public RetryInfo.Builder clearRetryDelay()
Clients should wait at least this long between retrying the same request.
.google.protobuf.Duration retry_delay = 1;
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
clone()
public RetryInfo.Builder clone()
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
getDefaultInstanceForType()
public RetryInfo getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RetryInfo |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getRetryDelayBuilder()
public Duration.Builder getRetryDelayBuilder()
Clients should wait at least this long between retrying the same request.
.google.protobuf.Duration retry_delay = 1;
Returns | |
---|---|
Type | Description |
Builder |
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 |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RetryInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RetryInfo.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
mergeFrom(RetryInfo other)
public RetryInfo.Builder mergeFrom(RetryInfo other)
Parameter | |
---|---|
Name | Description |
other | RetryInfo |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
mergeRetryDelay(Duration value)
public RetryInfo.Builder mergeRetryDelay(Duration value)
Clients should wait at least this long between retrying the same request.
.google.protobuf.Duration retry_delay = 1;
Parameter | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RetryInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RetryInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RetryInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
setRetryDelay(Duration value)
public RetryInfo.Builder setRetryDelay(Duration value)
Clients should wait at least this long between retrying the same request.
.google.protobuf.Duration retry_delay = 1;
Parameter | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
setRetryDelay(Duration.Builder builderForValue)
public RetryInfo.Builder setRetryDelay(Duration.Builder builderForValue)
Clients should wait at least this long between retrying the same request.
.google.protobuf.Duration retry_delay = 1;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final RetryInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RetryInfo.Builder |