RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

JSON representation
{
  "maxAttempts": integer,
  "maxRetryDuration": string,
  "minBackoff": string,
  "maxBackoff": string,
  "maxDoublings": integer
}
Fields
maxAttempts

integer

Number of attempts per task, including the first attempt. (If the first attempt fails, there will be maxAttempts - 1 retries.)

Must be greater than or equal to -1, which indicates unlimited attempts.

Cloud Tasks stops retrying only when maxAttempts and maxRetryDuration are both satisfied, or when the task is successfully executed. When the task has been attempted maxAttempts times and when the maxRetryDuration time has passed, no further attempts are made, and the task is deleted. If maxAttempts is set to -1 and maxRetryDuration is set to 0, the task is retried until the maximum task retention limit is reached.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field has the same meaning as task_retry_limit in queue.yaml/xml.

maxRetryDuration

string (Duration format)

If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts are made and the task is deleted.

A zero (0) indicates an unlimited duration, up to the maximum task retention limit.

The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For the maximum possible value or the format, see the documentation for Duration. maxRetryDuration will be truncated to the nearest second.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field has the same meaning as taskAgeLimit in queue.yaml/xml.

minBackoff

string (Duration format)

A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.

The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. minBackoff will be truncated to the nearest second.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field has the same meaning as min_backoff_seconds in queue.yaml/xml.

maxBackoff

string (Duration format)

A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried.

The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. maxBackoff will be truncated to the nearest second.

If unspecified when the queue is created, Cloud Tasks will pick the default.

This field has the same meaning as max_backoff_seconds in queue.yaml/xml.

maxDoublings

integer

The time between retries will double maxDoublings times.

A task's retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries at intervals of maxBackoff up to maxAttempts times.

For example, if minBackoff is 10s, maxBackoff is 300s, and maxDoublings 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 maxBackoff until the task has been attempted maxAttempts 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 has the same meaning as maxDoublings in queue.yaml/xml.