Class RetryConfig
Retry config. These settings determine when a failed task attempt is retried.
Implements
Inherited Members
Namespace: Google.Apis.CloudTasks.v2.Data
Assembly: Google.Apis.CloudTasks.v2.dll
Syntax
public class RetryConfig : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
MaxAttempts
Number of attempts per 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 >= -1. If unspecified when the
queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the
same meaning as task_retry_limit in
queue.yaml/xml.
Note: Cloud Tasks stops retrying only when max_attempts and max_retry_duration are both satisfied. When
the task has been attempted max_attempts times and when the max_retry_duration time has passed, no
further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set
max_attempts to -1 and max_retry_duration to 0.
Declaration
[JsonProperty("maxAttempts")]
public virtual int? MaxAttempts { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
MaxBackoff
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. 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. max_backoff will be
truncated to the nearest second. This field has the same meaning as max_backoff_seconds in
queue.yaml/xml.
Declaration
[JsonProperty("maxBackoff")]
public virtual object MaxBackoff { get; set; }
Property Value
| Type | Description |
|---|---|
| object |
MaxDoublings
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 has the same
meaning as max_doublings in
queue.yaml/xml.
Declaration
[JsonProperty("maxDoublings")]
public virtual int? MaxDoublings { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
MaxRetryDuration
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. 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. max_retry_duration will be
truncated to the nearest second. This field has the same meaning as task_age_limit in
queue.yaml/xml.
Declaration
[JsonProperty("maxRetryDuration")]
public virtual object MaxRetryDuration { get; set; }
Property Value
| Type | Description |
|---|---|
| object |
MinBackoff
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. 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. min_backoff will be
truncated to the nearest second. This field has the same meaning as min_backoff_seconds in
queue.yaml/xml.
Declaration
[JsonProperty("minBackoff")]
public virtual object MinBackoff { get; set; }
Property Value
| Type | Description |
|---|---|
| object |