- 2.52.0 (latest)
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
public static final class RetryConfig.Builder extends GeneratedMessageV3.Builder<RetryConfig.Builder> implements RetryConfigOrBuilder
Retry config.
These settings determine when a failed task attempt is retried.
Protobuf type google.cloud.tasks.v2.RetryConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RetryConfig.BuilderImplements
RetryConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RetryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
build()
public RetryConfig build()
Returns | |
---|---|
Type | Description |
RetryConfig |
buildPartial()
public RetryConfig buildPartial()
Returns | |
---|---|
Type | Description |
RetryConfig |
clear()
public RetryConfig.Builder clear()
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
clearField(Descriptors.FieldDescriptor field)
public RetryConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
clearMaxAttempts()
public RetryConfig.Builder clearMaxAttempts()
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.
int32 max_attempts = 1;
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
This builder for chaining. |
clearMaxBackoff()
public RetryConfig.Builder clearMaxBackoff()
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 max_backoff = 4;
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
clearMaxDoublings()
public RetryConfig.Builder clearMaxDoublings()
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.
int32 max_doublings = 5;
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
This builder for chaining. |
clearMaxRetryDuration()
public RetryConfig.Builder clearMaxRetryDuration()
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.
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 = 2;
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
clearMinBackoff()
public RetryConfig.Builder clearMinBackoff()
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 min_backoff = 3;
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RetryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
clone()
public RetryConfig.Builder clone()
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
getDefaultInstanceForType()
public RetryConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RetryConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMaxAttempts()
public int getMaxAttempts()
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.
int32 max_attempts = 1;
Returns | |
---|---|
Type | Description |
int |
The maxAttempts. |
getMaxBackoff()
public Duration getMaxBackoff()
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 max_backoff = 4;
Returns | |
---|---|
Type | Description |
Duration |
The maxBackoff. |
getMaxBackoffBuilder()
public Duration.Builder getMaxBackoffBuilder()
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 max_backoff = 4;
Returns | |
---|---|
Type | Description |
Builder |
getMaxBackoffOrBuilder()
public DurationOrBuilder getMaxBackoffOrBuilder()
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 max_backoff = 4;
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getMaxDoublings()
public int getMaxDoublings()
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.
int32 max_doublings = 5;
Returns | |
---|---|
Type | Description |
int |
The maxDoublings. |
getMaxRetryDuration()
public 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 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 max_retry_duration = 2;
Returns | |
---|---|
Type | Description |
Duration |
The maxRetryDuration. |
getMaxRetryDurationBuilder()
public Duration.Builder getMaxRetryDurationBuilder()
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.
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 = 2;
Returns | |
---|---|
Type | Description |
Builder |
getMaxRetryDurationOrBuilder()
public 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 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 max_retry_duration = 2;
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getMinBackoff()
public Duration getMinBackoff()
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 min_backoff = 3;
Returns | |
---|---|
Type | Description |
Duration |
The minBackoff. |
getMinBackoffBuilder()
public Duration.Builder getMinBackoffBuilder()
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 min_backoff = 3;
Returns | |
---|---|
Type | Description |
Builder |
getMinBackoffOrBuilder()
public DurationOrBuilder getMinBackoffOrBuilder()
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 min_backoff = 3;
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
hasMaxBackoff()
public boolean hasMaxBackoff()
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 max_backoff = 4;
Returns | |
---|---|
Type | Description |
boolean |
Whether the maxBackoff field is set. |
hasMaxRetryDuration()
public 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 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 max_retry_duration = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the maxRetryDuration field is set. |
hasMinBackoff()
public boolean hasMinBackoff()
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 min_backoff = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the minBackoff field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(RetryConfig other)
public RetryConfig.Builder mergeFrom(RetryConfig other)
Parameter | |
---|---|
Name | Description |
other |
RetryConfig |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RetryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RetryConfig.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
mergeMaxBackoff(Duration value)
public RetryConfig.Builder mergeMaxBackoff(Duration value)
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 max_backoff = 4;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
mergeMaxRetryDuration(Duration value)
public RetryConfig.Builder mergeMaxRetryDuration(Duration value)
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.
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 = 2;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
mergeMinBackoff(Duration value)
public RetryConfig.Builder mergeMinBackoff(Duration value)
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 min_backoff = 3;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RetryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RetryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setMaxAttempts(int value)
public RetryConfig.Builder setMaxAttempts(int value)
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.
int32 max_attempts = 1;
Parameter | |
---|---|
Name | Description |
value |
int The maxAttempts to set. |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
This builder for chaining. |
setMaxBackoff(Duration value)
public RetryConfig.Builder setMaxBackoff(Duration value)
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 max_backoff = 4;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setMaxBackoff(Duration.Builder builderForValue)
public RetryConfig.Builder setMaxBackoff(Duration.Builder builderForValue)
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 max_backoff = 4;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setMaxDoublings(int value)
public RetryConfig.Builder setMaxDoublings(int value)
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.
int32 max_doublings = 5;
Parameter | |
---|---|
Name | Description |
value |
int The maxDoublings to set. |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
This builder for chaining. |
setMaxRetryDuration(Duration value)
public RetryConfig.Builder setMaxRetryDuration(Duration value)
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.
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 = 2;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setMaxRetryDuration(Duration.Builder builderForValue)
public RetryConfig.Builder setMaxRetryDuration(Duration.Builder builderForValue)
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.
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 = 2;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setMinBackoff(Duration value)
public RetryConfig.Builder setMinBackoff(Duration value)
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 min_backoff = 3;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setMinBackoff(Duration.Builder builderForValue)
public RetryConfig.Builder setMinBackoff(Duration.Builder builderForValue)
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 min_backoff = 3;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RetryConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final RetryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RetryConfig.Builder |