- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 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.13
- 2.2.0
- 2.1.23
public static final class RetryConfig.Builder extends GeneratedMessageV3.Builder<RetryConfig.Builder> implements RetryConfigOrBuilderSettings that determine the retry behavior.
By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.
Protobuf type google.cloud.scheduler.v1beta1.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 |
|
clearMaxBackoffDuration()
public RetryConfig.Builder clearMaxBackoffDuration()The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
clearMaxDoublings()
public RetryConfig.Builder clearMaxDoublings() The time between retries will double max_doublings times.
A job's retry interval starts at
min_backoff_duration,
then doubles max_doublings times, then increases linearly, and finally
retries at intervals of
max_backoff_duration
up to retry_count
times.
For example, if
min_backoff_duration
is 10s,
max_backoff_duration
is 300s, and max_doublings is 3, then the a job will first be retried in
10s. The retry interval will double three times, and then increase linearly
by 2^3 * 10s. Finally, the job will retry at intervals of
max_backoff_duration
until the job has been attempted
retry_count
times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s,
300s, 300s, ....
The default value of this field is 5.
int32 max_doublings = 5;
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
This builder for chaining. |
clearMaxRetryDuration()
public RetryConfig.Builder clearMaxRetryDuration()The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
clearMinBackoffDuration()
public RetryConfig.Builder clearMinBackoffDuration()The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 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 |
|
clearRetryCount()
public RetryConfig.Builder clearRetryCount()The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings.
The default value of retry_count is zero.
If retry_count is zero, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time.
If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first.
Values greater than 5 and negative values are not allowed.
int32 retry_count = 1;
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
This builder for chaining. |
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 |
|
getMaxBackoffDuration()
public Duration getMaxBackoffDuration()The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Returns | |
|---|---|
| Type | Description |
Duration |
The maxBackoffDuration. |
getMaxBackoffDurationBuilder()
public Duration.Builder getMaxBackoffDurationBuilder()The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getMaxBackoffDurationOrBuilder()
public DurationOrBuilder getMaxBackoffDurationOrBuilder()The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMaxDoublings()
public int getMaxDoublings() The time between retries will double max_doublings times.
A job's retry interval starts at
min_backoff_duration,
then doubles max_doublings times, then increases linearly, and finally
retries at intervals of
max_backoff_duration
up to retry_count
times.
For example, if
min_backoff_duration
is 10s,
max_backoff_duration
is 300s, and max_doublings is 3, then the a job will first be retried in
10s. The retry interval will double three times, and then increase linearly
by 2^3 * 10s. Finally, the job will retry at intervals of
max_backoff_duration
until the job has been attempted
retry_count
times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s,
300s, 300s, ....
The default value of this field is 5.
int32 max_doublings = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The maxDoublings. |
getMaxRetryDuration()
public Duration getMaxRetryDuration()The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Returns | |
|---|---|
| Type | Description |
Duration |
The maxRetryDuration. |
getMaxRetryDurationBuilder()
public Duration.Builder getMaxRetryDurationBuilder()The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getMaxRetryDurationOrBuilder()
public DurationOrBuilder getMaxRetryDurationOrBuilder()The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMinBackoffDuration()
public Duration getMinBackoffDuration()The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 3;
| Returns | |
|---|---|
| Type | Description |
Duration |
The minBackoffDuration. |
getMinBackoffDurationBuilder()
public Duration.Builder getMinBackoffDurationBuilder()The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 3;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getMinBackoffDurationOrBuilder()
public DurationOrBuilder getMinBackoffDurationOrBuilder()The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 3;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getRetryCount()
public int getRetryCount()The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings.
The default value of retry_count is zero.
If retry_count is zero, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time.
If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first.
Values greater than 5 and negative values are not allowed.
int32 retry_count = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The retryCount. |
hasMaxBackoffDuration()
public boolean hasMaxBackoffDuration()The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxBackoffDuration field is set. |
hasMaxRetryDuration()
public boolean hasMaxRetryDuration()The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxRetryDuration field is set. |
hasMinBackoffDuration()
public boolean hasMinBackoffDuration()The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the minBackoffDuration 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 |
|
mergeMaxBackoffDuration(Duration value)
public RetryConfig.Builder mergeMaxBackoffDuration(Duration value)The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
mergeMaxRetryDuration(Duration value)
public RetryConfig.Builder mergeMaxRetryDuration(Duration value)The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
mergeMinBackoffDuration(Duration value)
public RetryConfig.Builder mergeMinBackoffDuration(Duration value)The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 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 |
|
setMaxBackoffDuration(Duration value)
public RetryConfig.Builder setMaxBackoffDuration(Duration value)The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
setMaxBackoffDuration(Duration.Builder builderForValue)
public RetryConfig.Builder setMaxBackoffDuration(Duration.Builder builderForValue)The maximum amount of time to wait before retrying a job after it fails.
The default value of this field is 1 hour.
.google.protobuf.Duration max_backoff_duration = 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 job's retry interval starts at
min_backoff_duration,
then doubles max_doublings times, then increases linearly, and finally
retries at intervals of
max_backoff_duration
up to retry_count
times.
For example, if
min_backoff_duration
is 10s,
max_backoff_duration
is 300s, and max_doublings is 3, then the a job will first be retried in
10s. The retry interval will double three times, and then increase linearly
by 2^3 * 10s. Finally, the job will retry at intervals of
max_backoff_duration
until the job has been attempted
retry_count
times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s,
300s, 300s, ....
The default value of this field is 5.
int32 max_doublings = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxDoublings to set. |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
This builder for chaining. |
setMaxRetryDuration(Duration value)
public RetryConfig.Builder setMaxRetryDuration(Duration value)The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.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)The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached.
The default value for max_retry_duration is zero, which means retry duration is unlimited.
.google.protobuf.Duration max_retry_duration = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
setMinBackoffDuration(Duration value)
public RetryConfig.Builder setMinBackoffDuration(Duration value)The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
setMinBackoffDuration(Duration.Builder builderForValue)
public RetryConfig.Builder setMinBackoffDuration(Duration.Builder builderForValue)The minimum amount of time to wait before retrying a job after it fails.
The default value of this field is 5 seconds.
.google.protobuf.Duration min_backoff_duration = 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 |
|
setRetryCount(int value)
public RetryConfig.Builder setRetryCount(int value)The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings.
The default value of retry_count is zero.
If retry_count is zero, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time.
If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first.
Values greater than 5 and negative values are not allowed.
int32 retry_count = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe retryCount to set. |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RetryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|