Interface RetryConfigOrBuilder (2.19.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
publicinterface RetryConfigOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getMaxAttempts()
publicabstractintgetMaxAttempts()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()
publicabstractDurationgetMaxBackoff()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()
publicabstractDurationOrBuildergetMaxBackoffOrBuilder()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 |
DurationOrBuilder |
|
getMaxDoublings()
publicabstractintgetMaxDoublings() 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()
publicabstractDurationgetMaxRetryDuration() 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()
publicabstractDurationOrBuildergetMaxRetryDurationOrBuilder() 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 |
DurationOrBuilder |
|
getMinBackoff()
publicabstractDurationgetMinBackoff()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()
publicabstractDurationOrBuildergetMinBackoffOrBuilder()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 |
DurationOrBuilder |
|
getNumAttemptsCase()
publicabstractRetryConfig.NumAttemptsCasegetNumAttemptsCase()| Returns | |
|---|---|
| Type | Description |
RetryConfig.NumAttemptsCase |
|
getUnlimitedAttempts()
publicabstractbooleangetUnlimitedAttempts()If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
The unlimitedAttempts. |
hasMaxAttempts()
publicabstractbooleanhasMaxAttempts()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()
publicabstractbooleanhasMaxBackoff()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()
publicabstractbooleanhasMaxRetryDuration() 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()
publicabstractbooleanhasMinBackoff()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()
publicabstractbooleanhasUnlimitedAttempts()If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the unlimitedAttempts field is set. |