public final class RetryConfig extends GeneratedMessageV3 implements RetryConfigOrBuilder
Retry config.
These settings determine how a failed task attempt is retried.
Protobuf type google.cloud.tasks.v2beta2.RetryConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
MAX_ATTEMPTS_FIELD_NUMBER
public static final int MAX_ATTEMPTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_BACKOFF_FIELD_NUMBER
public static final int MAX_BACKOFF_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_DOUBLINGS_FIELD_NUMBER
public static final int MAX_DOUBLINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_RETRY_DURATION_FIELD_NUMBER
public static final int MAX_RETRY_DURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MIN_BACKOFF_FIELD_NUMBER
public static final int MIN_BACKOFF_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UNLIMITED_ATTEMPTS_FIELD_NUMBER
public static final int UNLIMITED_ATTEMPTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RetryConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RetryConfig.Builder newBuilder()
newBuilder(RetryConfig prototype)
public static RetryConfig.Builder newBuilder(RetryConfig prototype)
public static RetryConfig parseDelimitedFrom(InputStream input)
public static RetryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RetryConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RetryConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(CodedInputStream input)
public static RetryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(InputStream input)
public static RetryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RetryConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RetryConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public RetryConfig getDefaultInstanceForType()
getMaxAttempts()
public int getMaxAttempts()
The maximum number of attempts for a task.
Cloud Tasks will attempt the task max_attempts times (that
is, if the first attempt fails, then there will be
max_attempts - 1 retries). Must be > 0.
int32 max_attempts = 1;
| Returns |
|---|
| Type | Description |
int | The maxAttempts.
|
getMaxBackoff()
public Duration getMaxBackoff()
A task will be scheduled
for retry between
min_backoff and
max_backoff duration
after it fails, if the queue's
RetryConfig specifies that the
task should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
max_backoff will be truncated to the nearest second.
This field has the same meaning as
max_backoff_seconds in
queue.yaml/xml.
.google.protobuf.Duration max_backoff = 5;
| Returns |
|---|
| Type | Description |
Duration | The maxBackoff.
|
getMaxBackoffOrBuilder()
public DurationOrBuilder getMaxBackoffOrBuilder()
A task will be scheduled
for retry between
min_backoff and
max_backoff duration
after it fails, if the queue's
RetryConfig specifies that the
task should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
max_backoff will be truncated to the nearest second.
This field has the same meaning as
max_backoff_seconds in
queue.yaml/xml.
.google.protobuf.Duration max_backoff = 5;
getMaxDoublings()
public int getMaxDoublings()
The time between retries will double max_doublings times.
A task's retry interval starts at
min_backoff, then
doubles max_doublings times, then increases linearly, and finally retries
at intervals of
max_backoff up to
max_attempts times.
For example, if
min_backoff is 10s,
max_backoff is 300s,
and max_doublings is 3, then the a task will first be retried in 10s. The
retry interval will double three times, and then increase linearly by 2^3 *
10s. Finally, the task will retry at intervals of
max_backoff until the
task has been attempted
max_attempts times.
Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
300s, ....
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
This field has the same meaning as
max_doublings in
queue.yaml/xml.
int32 max_doublings = 6;
| Returns |
|---|
| Type | Description |
int | The maxDoublings.
|
getMaxRetryDuration()
public Duration getMaxRetryDuration()
If positive, max_retry_duration specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once max_retry_duration time has passed and the
task has been attempted
max_attempts times,
no further attempts will be made and the task will be deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
max_retry_duration will be truncated to the nearest second.
This field has the same meaning as
task_age_limit in
queue.yaml/xml.
.google.protobuf.Duration max_retry_duration = 3;
| Returns |
|---|
| Type | Description |
Duration | The maxRetryDuration.
|
getMaxRetryDurationOrBuilder()
public DurationOrBuilder getMaxRetryDurationOrBuilder()
If positive, max_retry_duration specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once max_retry_duration time has passed and the
task has been attempted
max_attempts times,
no further attempts will be made and the task will be deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
max_retry_duration will be truncated to the nearest second.
This field has the same meaning as
task_age_limit in
queue.yaml/xml.
.google.protobuf.Duration max_retry_duration = 3;
getMinBackoff()
public Duration getMinBackoff()
A task will be scheduled
for retry between
min_backoff and
max_backoff duration
after it fails, if the queue's
RetryConfig specifies that the
task should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
min_backoff will be truncated to the nearest second.
This field has the same meaning as
min_backoff_seconds in
queue.yaml/xml.
.google.protobuf.Duration min_backoff = 4;
| Returns |
|---|
| Type | Description |
Duration | The minBackoff.
|
getMinBackoffOrBuilder()
public DurationOrBuilder getMinBackoffOrBuilder()
A task will be scheduled
for retry between
min_backoff and
max_backoff duration
after it fails, if the queue's
RetryConfig specifies that the
task should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
min_backoff will be truncated to the nearest second.
This field has the same meaning as
min_backoff_seconds in
queue.yaml/xml.
.google.protobuf.Duration min_backoff = 4;
getNumAttemptsCase()
public RetryConfig.NumAttemptsCase getNumAttemptsCase()
getParserForType()
public Parser<RetryConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUnlimitedAttempts()
public boolean getUnlimitedAttempts()
If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
| Returns |
|---|
| Type | Description |
boolean | The unlimitedAttempts.
|
hasMaxAttempts()
public boolean hasMaxAttempts()
The maximum number of attempts for a task.
Cloud Tasks will attempt the task max_attempts times (that
is, if the first attempt fails, then there will be
max_attempts - 1 retries). Must be > 0.
int32 max_attempts = 1;
| Returns |
|---|
| Type | Description |
boolean | Whether the maxAttempts field is set.
|
hasMaxBackoff()
public boolean hasMaxBackoff()
A task will be scheduled
for retry between
min_backoff and
max_backoff duration
after it fails, if the queue's
RetryConfig specifies that the
task should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
max_backoff will be truncated to the nearest second.
This field has the same meaning as
max_backoff_seconds in
queue.yaml/xml.
.google.protobuf.Duration max_backoff = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the maxBackoff field is set.
|
hasMaxRetryDuration()
public boolean hasMaxRetryDuration()
If positive, max_retry_duration specifies the time limit for
retrying a failed task, measured from when the task was first
attempted. Once max_retry_duration time has passed and the
task has been attempted
max_attempts times,
no further attempts will be made and the task will be deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
max_retry_duration will be truncated to the nearest second.
This field has the same meaning as
task_age_limit in
queue.yaml/xml.
.google.protobuf.Duration max_retry_duration = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the maxRetryDuration field is set.
|
hasMinBackoff()
public boolean hasMinBackoff()
A task will be scheduled
for retry between
min_backoff and
max_backoff duration
after it fails, if the queue's
RetryConfig specifies that the
task should be retried.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
This field is output only for pull
queues.
min_backoff will be truncated to the nearest second.
This field has the same meaning as
min_backoff_seconds in
queue.yaml/xml.
.google.protobuf.Duration min_backoff = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the minBackoff field is set.
|
hasUnlimitedAttempts()
public boolean hasUnlimitedAttempts()
If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the unlimitedAttempts field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RetryConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RetryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RetryConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
