Package com.google.cloud.tasks.v2beta2

Interface RetryConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RetryConfig, RetryConfig.Builder
@Generated public interface RetryConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaxAttempts()
    The maximum number of attempts for a task.
    com.google.protobuf.Duration
    getMaxBackoff()
    A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
    com.google.protobuf.DurationOrBuilder
    getMaxBackoffOrBuilder()
    A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
    int
    getMaxDoublings()
    The time between retries will double `max_doublings` times.
    com.google.protobuf.Duration
    getMaxRetryDuration()
    If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted.
    com.google.protobuf.DurationOrBuilder
    getMaxRetryDurationOrBuilder()
    If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted.
    com.google.protobuf.Duration
    getMinBackoff()
    A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
    com.google.protobuf.DurationOrBuilder
    getMinBackoffOrBuilder()
    A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
    RetryConfig.NumAttemptsCase
    getNumAttemptsCase()
     
    boolean
    getUnlimitedAttempts()
    If true, then the number of attempts is unlimited.
    boolean
    hasMaxAttempts()
    The maximum number of attempts for a task.
    boolean
    hasMaxBackoff()
    A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
    boolean
    hasMaxRetryDuration()
    If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted.
    boolean
    hasMinBackoff()
    A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
    boolean
    hasUnlimitedAttempts()
    If true, then the number of attempts is unlimited.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasMaxAttempts

      boolean hasMaxAttempts()
       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.
      int32 max_attempts = 1;
      Returns:
      Whether the maxAttempts field is set.

    • getMaxAttempts

      int 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.
      int32 max_attempts = 1;
      Returns:
      The maxAttempts.

    • hasUnlimitedAttempts

      boolean hasUnlimitedAttempts()
       If true, then the number of attempts is unlimited.
      bool unlimited_attempts = 2;
      Returns:
      Whether the unlimitedAttempts field is set.

    • getUnlimitedAttempts

      boolean getUnlimitedAttempts()
       If true, then the number of attempts is unlimited.
      bool unlimited_attempts = 2;
      Returns:
      The unlimitedAttempts.

    • hasMaxRetryDuration

      boolean hasMaxRetryDuration()
       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][google.cloud.tasks.v2beta2.RetryConfig.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration max_retry_duration = 3;
      Returns:
      Whether the maxRetryDuration field is set.

    • getMaxRetryDuration

      com.google.protobuf.Duration 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][google.cloud.tasks.v2beta2.RetryConfig.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration max_retry_duration = 3;
      Returns:
      The maxRetryDuration.

    • getMaxRetryDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getMaxRetryDurationOrBuilder()
       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][google.cloud.tasks.v2beta2.RetryConfig.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration max_retry_duration = 3;

    • hasMinBackoff

      boolean hasMinBackoff()
       A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
 for retry between
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
 after it fails, if the queue's
 [RetryConfig][google.cloud.tasks.v2beta2.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration min_backoff = 4;
      Returns:
      Whether the minBackoff field is set.

    • getMinBackoff

      com.google.protobuf.Duration getMinBackoff()
       A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
 for retry between
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
 after it fails, if the queue's
 [RetryConfig][google.cloud.tasks.v2beta2.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration min_backoff = 4;
      Returns:
      The minBackoff.

    • getMinBackoffOrBuilder

      com.google.protobuf.DurationOrBuilder getMinBackoffOrBuilder()
       A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
 for retry between
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
 after it fails, if the queue's
 [RetryConfig][google.cloud.tasks.v2beta2.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration min_backoff = 4;

    • hasMaxBackoff

      boolean hasMaxBackoff()
       A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
 for retry between
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
 after it fails, if the queue's
 [RetryConfig][google.cloud.tasks.v2beta2.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration max_backoff = 5;
      Returns:
      Whether the maxBackoff field is set.

    • getMaxBackoff

      com.google.protobuf.Duration getMaxBackoff()
       A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
 for retry between
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
 after it fails, if the queue's
 [RetryConfig][google.cloud.tasks.v2beta2.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration max_backoff = 5;
      Returns:
      The maxBackoff.

    • getMaxBackoffOrBuilder

      com.google.protobuf.DurationOrBuilder getMaxBackoffOrBuilder()
       A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
 for retry between
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration
 after it fails, if the queue's
 [RetryConfig][google.cloud.tasks.v2beta2.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      .google.protobuf.Duration max_backoff = 5;

    • getMaxDoublings

      int getMaxDoublings()
       The time between retries will double `max_doublings` times.

 A task's retry interval starts at
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then
 doubles `max_doublings` times, then increases linearly, and finally retries
 at intervals of
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to
 [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times.

 For example, if
 [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s,
 [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.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][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] until the
 task has been attempted
 [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.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](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
      int32 max_doublings = 6;
      Returns:
      The maxDoublings.

    • getNumAttemptsCase

      RetryConfig.NumAttemptsCase getNumAttemptsCase()