Reference documentation and code samples for the Google Cloud Tasks V2beta2 Client class RetryConfig.
Retry config.
These settings determine how a failed task attempt is retried.
Generated from protobuf message google.cloud.tasks.v2beta2.RetryConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_attempts |
int
The maximum number of attempts for a task. Cloud Tasks will attempt the task |
↳ unlimited_attempts |
bool
If true, then the number of attempts is unlimited. |
↳ max_retry_duration |
Google\Protobuf\Duration
If positive, |
↳ min_backoff |
Google\Protobuf\Duration
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 |
Google\Protobuf\Duration
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_doublings |
int
The time between retries will double |
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.
| Returns | |
|---|---|
| Type | Description |
int | |
hasMaxAttempts
setMaxAttempts
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUnlimitedAttempts
If true, then the number of attempts is unlimited.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasUnlimitedAttempts
setUnlimitedAttempts
If true, then the number of attempts is unlimited.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasMaxRetryDuration
clearMaxRetryDuration
setMaxRetryDuration
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasMinBackoff
clearMinBackoff
setMinBackoff
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasMaxBackoff
clearMaxBackoff
setMaxBackoff
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxDoublings
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNumAttempts
| Returns | |
|---|---|
| Type | Description |
string | |