Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::RetryConfig.
Retry config.
These settings determine when a failed task attempt is retried.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#max_attempts
def max_attempts() -> ::Integer
-
(::Integer) — Number of attempts per task.
Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_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.
#max_attempts=
def max_attempts=(value) -> ::Integer
-
value (::Integer) — Number of attempts per task.
Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_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.
-
(::Integer) — Number of attempts per task.
Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_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.
#max_backoff
def max_backoff() -> ::Google::Protobuf::Duration
-
(::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.
max_backoff
will be truncated to the nearest second.This field has the same meaning as max_backoff_seconds in queue.yaml/xml.
#max_backoff=
def max_backoff=(value) -> ::Google::Protobuf::Duration
-
value (::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.
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) — 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.
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
def max_doublings() -> ::Integer
-
(::Integer) — 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 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.
#max_doublings=
def max_doublings=(value) -> ::Integer
-
value (::Integer) — 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 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.
-
(::Integer) — 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 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.
#max_retry_duration
def max_retry_duration() -> ::Google::Protobuf::Duration
-
(::Google::Protobuf::Duration) — If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_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.
max_retry_duration
will be truncated to the nearest second.This field has the same meaning as task_age_limit in queue.yaml/xml.
#max_retry_duration=
def max_retry_duration=(value) -> ::Google::Protobuf::Duration
-
value (::Google::Protobuf::Duration) — If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_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.
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) — If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_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.
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
def min_backoff() -> ::Google::Protobuf::Duration
-
(::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.
min_backoff
will be truncated to the nearest second.This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
#min_backoff=
def min_backoff=(value) -> ::Google::Protobuf::Duration
-
value (::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.
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) — 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.
min_backoff
will be truncated to the nearest second.This field has the same meaning as min_backoff_seconds in queue.yaml/xml.