Package com.google.cloud.scheduler.v1
Class RetryConfig.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RetryConfig.Builder>
com.google.cloud.scheduler.v1.RetryConfig.Builder
- All Implemented Interfaces:
RetryConfigOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- RetryConfig
public static final class RetryConfig.Builder
extends com.google.protobuf.GeneratedMessage.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][google.cloud.scheduler.v1.RetryConfig].Protobuf type
google.cloud.scheduler.v1.RetryConfig-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()The maximum amount of time to wait before retrying a job after it fails.The time between retries will double `max_doublings` times.The time limit for retrying a failed job, measured from time when an execution was first attempted.The minimum amount of time to wait before retrying a job after it fails.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].static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.DurationThe maximum amount of time to wait before retrying a job after it fails.com.google.protobuf.Duration.BuilderThe maximum amount of time to wait before retrying a job after it fails.com.google.protobuf.DurationOrBuilderThe maximum amount of time to wait before retrying a job after it fails.intThe time between retries will double `max_doublings` times.com.google.protobuf.DurationThe time limit for retrying a failed job, measured from time when an execution was first attempted.com.google.protobuf.Duration.BuilderThe time limit for retrying a failed job, measured from time when an execution was first attempted.com.google.protobuf.DurationOrBuilderThe time limit for retrying a failed job, measured from time when an execution was first attempted.com.google.protobuf.DurationThe minimum amount of time to wait before retrying a job after it fails.com.google.protobuf.Duration.BuilderThe minimum amount of time to wait before retrying a job after it fails.com.google.protobuf.DurationOrBuilderThe minimum amount of time to wait before retrying a job after it fails.intThe 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].booleanThe maximum amount of time to wait before retrying a job after it fails.booleanThe time limit for retrying a failed job, measured from time when an execution was first attempted.booleanThe minimum amount of time to wait before retrying a job after it fails.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(RetryConfig other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeMaxBackoffDuration(com.google.protobuf.Duration value) The maximum amount of time to wait before retrying a job after it fails.mergeMaxRetryDuration(com.google.protobuf.Duration value) The time limit for retrying a failed job, measured from time when an execution was first attempted.mergeMinBackoffDuration(com.google.protobuf.Duration value) The minimum amount of time to wait before retrying a job after it fails.setMaxBackoffDuration(com.google.protobuf.Duration value) The maximum amount of time to wait before retrying a job after it fails.setMaxBackoffDuration(com.google.protobuf.Duration.Builder builderForValue) The maximum amount of time to wait before retrying a job after it fails.setMaxDoublings(int value) The time between retries will double `max_doublings` times.setMaxRetryDuration(com.google.protobuf.Duration value) The time limit for retrying a failed job, measured from time when an execution was first attempted.setMaxRetryDuration(com.google.protobuf.Duration.Builder builderForValue) The time limit for retrying a failed job, measured from time when an execution was first attempted.setMinBackoffDuration(com.google.protobuf.Duration value) The minimum amount of time to wait before retrying a job after it fails.setMinBackoffDuration(com.google.protobuf.Duration.Builder builderForValue) The minimum amount of time to wait before retrying a job after it fails.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][google.cloud.scheduler.v1.RetryConfig.max_doublings].Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<RetryConfig.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<RetryConfig.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<RetryConfig.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RetryConfig.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<RetryConfig.Builder>
-
mergeFrom
public RetryConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RetryConfig.Builder>- Throws:
IOException
-
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][google.cloud.scheduler.v1.RetryConfig.max_doublings]. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. 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;- Specified by:
getRetryCountin interfaceRetryConfigOrBuilder- Returns:
- The retryCount.
-
setRetryCount
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 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. 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;- Parameters:
value- The retryCount to set.- Returns:
- This builder for chaining.
-
clearRetryCount
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 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. 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:
- This builder for chaining.
-
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][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;- Specified by:
hasMaxRetryDurationin interfaceRetryConfigOrBuilder- Returns:
- Whether the maxRetryDuration field is set.
-
getMaxRetryDuration
public com.google.protobuf.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;- Specified by:
getMaxRetryDurationin interfaceRetryConfigOrBuilder- Returns:
- The maxRetryDuration.
-
setMaxRetryDuration
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; -
setMaxRetryDuration
public RetryConfig.Builder setMaxRetryDuration(com.google.protobuf.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][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; -
mergeMaxRetryDuration
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; -
clearMaxRetryDuration
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; -
getMaxRetryDurationBuilder
public com.google.protobuf.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][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; -
getMaxRetryDurationOrBuilder
public com.google.protobuf.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;- Specified by:
getMaxRetryDurationOrBuilderin interfaceRetryConfigOrBuilder
-
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;- Specified by:
hasMinBackoffDurationin interfaceRetryConfigOrBuilder- Returns:
- Whether the minBackoffDuration field is set.
-
getMinBackoffDuration
public com.google.protobuf.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;- Specified by:
getMinBackoffDurationin interfaceRetryConfigOrBuilder- Returns:
- The minBackoffDuration.
-
setMinBackoffDuration
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; -
setMinBackoffDuration
public RetryConfig.Builder setMinBackoffDuration(com.google.protobuf.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; -
mergeMinBackoffDuration
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; -
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; -
getMinBackoffDurationBuilder
public com.google.protobuf.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; -
getMinBackoffDurationOrBuilder
public com.google.protobuf.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;- Specified by:
getMinBackoffDurationOrBuilderin interfaceRetryConfigOrBuilder
-
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;- Specified by:
hasMaxBackoffDurationin interfaceRetryConfigOrBuilder- Returns:
- Whether the maxBackoffDuration field is set.
-
getMaxBackoffDuration
public com.google.protobuf.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;- Specified by:
getMaxBackoffDurationin interfaceRetryConfigOrBuilder- Returns:
- The maxBackoffDuration.
-
setMaxBackoffDuration
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; -
setMaxBackoffDuration
public RetryConfig.Builder setMaxBackoffDuration(com.google.protobuf.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; -
mergeMaxBackoffDuration
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; -
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; -
getMaxBackoffDurationBuilder
public com.google.protobuf.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; -
getMaxBackoffDurationOrBuilder
public com.google.protobuf.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;- Specified by:
getMaxBackoffDurationOrBuilderin interfaceRetryConfigOrBuilder
-
getMaxDoublings
public 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 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 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;- Specified by:
getMaxDoublingsin interfaceRetryConfigOrBuilder- Returns:
- The maxDoublings.
-
setMaxDoublings
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 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 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;- Parameters:
value- The maxDoublings to set.- Returns:
- This builder for chaining.
-
clearMaxDoublings
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 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 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:
- This builder for chaining.
-