Class RetryConfig.Builder (2.34.0)

public static final class RetryConfig.Builder extends GeneratedMessageV3.Builder<RetryConfig.Builder> implements RetryConfigOrBuilder

Settings 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.v1.RetryConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RetryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RetryConfig.Builder
Overrides

build()

public RetryConfig build()
Returns
TypeDescription
RetryConfig

buildPartial()

public RetryConfig buildPartial()
Returns
TypeDescription
RetryConfig

clear()

public RetryConfig.Builder clear()
Returns
TypeDescription
RetryConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RetryConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RetryConfig.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
RetryConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RetryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RetryConfig.Builder
Overrides

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
TypeDescription
RetryConfig.Builder

This builder for chaining.

clone()

public RetryConfig.Builder clone()
Returns
TypeDescription
RetryConfig.Builder
Overrides

getDefaultInstanceForType()

public RetryConfig getDefaultInstanceForType()
Returns
TypeDescription
RetryConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the minBackoffDuration field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RetryConfig other)

public RetryConfig.Builder mergeFrom(RetryConfig other)
Parameter
NameDescription
otherRetryConfig
Returns
TypeDescription
RetryConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RetryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RetryConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RetryConfig.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
RetryConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RetryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RetryConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RetryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RetryConfig.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueint

The maxDoublings to set.

Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
RetryConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RetryConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RetryConfig.Builder
Overrides

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
NameDescription
valueint

The retryCount to set.

Returns
TypeDescription
RetryConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RetryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RetryConfig.Builder
Overrides