Class RetryConfig (2.9.1)

RetryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Retry config. These settings determine how a failed task attempt is retried.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
max_attempts int
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. This field is a member of `oneof`_ ``num_attempts``.
unlimited_attempts bool
If true, then the number of attempts is unlimited. This field is a member of `oneof`_ ``num_attempts``.
max_retry_duration google.protobuf.duration_pb2.Duration
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][google.cloud.tasks.v2beta2.PullTarget]. ``max_retry_duration`` will be truncated to the nearest second. This field has the same meaning as `task_age_limit in queue.yaml/xml
min_backoff google.protobuf.duration_pb2.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][google.cloud.tasks.v2beta2.PullTarget]. ``min_backoff`` will be truncated to the nearest second. This field has the same meaning as `min_backoff_seconds in queue.yaml/xml
max_backoff google.protobuf.duration_pb2.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][google.cloud.tasks.v2beta2.PullTarget]. ``max_backoff`` will be truncated to the nearest second. This field has the same meaning as `max_backoff_seconds in queue.yaml/xml
max_doublings int
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][google.cloud.tasks.v2beta2.PullTarget]. This field has the same meaning as `max_doublings in queue.yaml/xml

Inheritance

builtins.object > proto.message.Message > RetryConfig