Class RetryConfig (2.70.0)

publicfinalclass RetryConfigextendsGeneratedMessageV3implementsRetryConfigOrBuilder

Retry config.

These settings determine how a failed task attempt is retried.

Protobuf type google.cloud.tasks.v2beta2.RetryConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RetryConfig

Implements

RetryConfigOrBuilder

Inherited Members

publicstaticfinalintMAX_ATTEMPTS_FIELD_NUMBER

publicstaticfinalintMAX_BACKOFF_FIELD_NUMBER

publicstaticfinalintMAX_DOUBLINGS_FIELD_NUMBER

publicstaticfinalintMAX_RETRY_DURATION_FIELD_NUMBER

publicstaticfinalintMIN_BACKOFF_FIELD_NUMBER

publicstaticfinalintUNLIMITED_ATTEMPTS_FIELD_NUMBER

publicstaticRetryConfiggetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticRetryConfig.BuildernewBuilder()

publicstaticRetryConfig.BuildernewBuilder(RetryConfigprototype)

publicstaticRetryConfigparseDelimitedFrom(InputStreaminput)

publicstaticRetryConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticRetryConfigparseFrom(byte[]data)

publicstaticRetryConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticRetryConfigparseFrom(ByteStringdata)

publicstaticRetryConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticRetryConfigparseFrom(CodedInputStreaminput)

publicstaticRetryConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticRetryConfigparseFrom(InputStreaminput)

publicstaticRetryConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticRetryConfigparseFrom(ByteBufferdata)

publicstaticRetryConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<RetryConfig>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicRetryConfiggetDefaultInstanceForType()

publicintgetMaxAttempts()

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;

publicDurationgetMaxBackoff()

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.

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 max_backoff = 5;

publicDurationOrBuildergetMaxBackoffOrBuilder()

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.

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 max_backoff = 5;

publicintgetMaxDoublings()

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.

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

int32 max_doublings = 6;

publicDurationgetMaxRetryDuration()

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.

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 max_retry_duration = 3;

publicDurationOrBuildergetMaxRetryDurationOrBuilder()

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.

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 max_retry_duration = 3;

publicDurationgetMinBackoff()

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.

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 min_backoff = 4;

publicDurationOrBuildergetMinBackoffOrBuilder()

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.

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 min_backoff = 4;

publicRetryConfig.NumAttemptsCasegetNumAttemptsCase()

publicParser<RetryConfig>getParserForType()

GeneratedMessageV3.getParserForType()

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicbooleangetUnlimitedAttempts()

If true, then the number of attempts is unlimited.

bool unlimited_attempts = 2;

publicbooleanhasMaxAttempts()

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;

publicbooleanhasMaxBackoff()

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.

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 max_backoff = 5;

publicbooleanhasMaxRetryDuration()

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.

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 max_retry_duration = 3;

publicbooleanhasMinBackoff()

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.

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 min_backoff = 4;

publicbooleanhasUnlimitedAttempts()

If true, then the number of attempts is unlimited.

bool unlimited_attempts = 2;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicRetryConfig.BuildernewBuilderForType()

protectedRetryConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicRetryConfig.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)