com.google.cloud.scheduler.v1

Interface RetryConfigOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

RetryConfig, RetryConfig.Builder

public interface RetryConfigOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Duration	getMaxBackoffDuration() The maximum amount of time to wait before retrying a job after it fails.
DurationOrBuilder	getMaxBackoffDurationOrBuilder() The maximum amount of time to wait before retrying a job after it fails.
int	getMaxDoublings() The time between retries will double `max_doublings` times.
Duration	getMaxRetryDuration() The time limit for retrying a failed job, measured from time when an execution was first attempted.
DurationOrBuilder	getMaxRetryDurationOrBuilder() The time limit for retrying a failed job, measured from time when an execution was first attempted.
Duration	getMinBackoffDuration() The minimum amount of time to wait before retrying a job after it fails.
DurationOrBuilder	getMinBackoffDurationOrBuilder() The minimum amount of time to wait before retrying a job after it fails.
int	getRetryCount() The number of attempts that the system will make to run a job using the exponential backoff procedure described by [max_doublings][google.cloud.scheduler.v1.RetryConfig.max_doublings].
boolean	hasMaxBackoffDuration() The maximum amount of time to wait before retrying a job after it fails.
boolean	hasMaxRetryDuration() The time limit for retrying a failed job, measured from time when an execution was first attempted.
boolean	hasMinBackoffDuration() The minimum amount of time to wait before retrying a job after it fails.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRetryCount

int getRetryCount()

 The number of attempts that the system will make to run a job using the
 exponential backoff procedure described by
 [max_doublings][google.cloud.scheduler.v1.RetryConfig.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:

The retryCount.

hasMaxRetryDuration

boolean hasMaxRetryDuration()

 The time limit for retrying a failed job, measured from time when an
 execution was first attempted. If specified with
 [retry_count][google.cloud.scheduler.v1.RetryConfig.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:

Whether the maxRetryDuration field is set.

getMaxRetryDuration

Duration getMaxRetryDuration()

 The time limit for retrying a failed job, measured from time when an
 execution was first attempted. If specified with
 [retry_count][google.cloud.scheduler.v1.RetryConfig.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:

The maxRetryDuration.

getMaxRetryDurationOrBuilder

DurationOrBuilder getMaxRetryDurationOrBuilder()

 The time limit for retrying a failed job, measured from time when an
 execution was first attempted. If specified with
 [retry_count][google.cloud.scheduler.v1.RetryConfig.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;

hasMinBackoffDuration

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:

Whether the minBackoffDuration field is set.

getMinBackoffDuration

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:

The minBackoffDuration.

getMinBackoffDurationOrBuilder

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;

hasMaxBackoffDuration

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:

Whether the maxBackoffDuration field is set.

getMaxBackoffDuration

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:

The maxBackoffDuration.

getMaxBackoffDurationOrBuilder

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;

getMaxDoublings

int getMaxDoublings()

 The time between retries will double `max_doublings` times.
 A job's retry interval starts at
 [min_backoff_duration][google.cloud.scheduler.v1.RetryConfig.min_backoff_duration], then doubles
 `max_doublings` times, then increases linearly, and finally
 retries retries at intervals of
 [max_backoff_duration][google.cloud.scheduler.v1.RetryConfig.max_backoff_duration] up to
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times.
 For example, if [min_backoff_duration][google.cloud.scheduler.v1.RetryConfig.min_backoff_duration] is
 10s, [max_backoff_duration][google.cloud.scheduler.v1.RetryConfig.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][google.cloud.scheduler.v1.RetryConfig.max_backoff_duration] until the job has
 been attempted [retry_count][google.cloud.scheduler.v1.RetryConfig.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:

The maxDoublings.