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][google.cloud.scheduler.v1.RetryConfig].Protobuf type
google.cloud.scheduler.v1.RetryConfig| Modifier and Type | Method and Description |
|---|---|
RetryConfig.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
Object value) |
RetryConfig |
build() |
RetryConfig |
buildPartial() |
RetryConfig.Builder |
clear() |
RetryConfig.Builder |
clearField(Descriptors.FieldDescriptor field) |
RetryConfig.Builder |
clearMaxBackoffDuration()
The maximum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
clearMaxDoublings()
The time between retries will double `max_doublings` times.
|
RetryConfig.Builder |
clearMaxRetryDuration()
The time limit for retrying a failed job, measured from time when an
execution was first attempted.
|
RetryConfig.Builder |
clearMinBackoffDuration()
The minimum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
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][google.cloud.scheduler.v1.RetryConfig.max_doublings].
|
RetryConfig.Builder |
clone() |
RetryConfig |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
Duration |
getMaxBackoffDuration()
The maximum amount of time to wait before retrying a job after
it fails.
|
Duration.Builder |
getMaxBackoffDurationBuilder()
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.
|
Duration.Builder |
getMaxRetryDurationBuilder()
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.
|
Duration.Builder |
getMinBackoffDurationBuilder()
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.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
RetryConfig.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
RetryConfig.Builder |
mergeFrom(Message other) |
RetryConfig.Builder |
mergeFrom(RetryConfig other) |
RetryConfig.Builder |
mergeMaxBackoffDuration(Duration value)
The maximum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
mergeMaxRetryDuration(Duration value)
The time limit for retrying a failed job, measured from time when an
execution was first attempted.
|
RetryConfig.Builder |
mergeMinBackoffDuration(Duration value)
The minimum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
RetryConfig.Builder |
setField(Descriptors.FieldDescriptor field,
Object value) |
RetryConfig.Builder |
setMaxBackoffDuration(Duration.Builder builderForValue)
The maximum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
setMaxBackoffDuration(Duration value)
The maximum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
setMaxDoublings(int value)
The time between retries will double `max_doublings` times.
|
RetryConfig.Builder |
setMaxRetryDuration(Duration.Builder builderForValue)
The time limit for retrying a failed job, measured from time when an
execution was first attempted.
|
RetryConfig.Builder |
setMaxRetryDuration(Duration value)
The time limit for retrying a failed job, measured from time when an
execution was first attempted.
|
RetryConfig.Builder |
setMinBackoffDuration(Duration.Builder builderForValue)
The minimum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
setMinBackoffDuration(Duration value)
The minimum amount of time to wait before retrying a job after
it fails.
|
RetryConfig.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value) |
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][google.cloud.scheduler.v1.RetryConfig.max_doublings].
|
RetryConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeDelimitedFrom, mergeDelimitedFrommergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<RetryConfig.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic RetryConfig build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic RetryConfig buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic RetryConfig.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<RetryConfig.Builder>public RetryConfig.Builder mergeFrom(RetryConfig other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<RetryConfig.Builder>public RetryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<RetryConfig.Builder>IOExceptionpublic 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;getRetryCount in interface RetryConfigOrBuilderpublic 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][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;value - The retryCount to set.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][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;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;hasMaxRetryDuration in interface RetryConfigOrBuilderpublic 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;getMaxRetryDuration in interface RetryConfigOrBuilderpublic 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][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;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][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;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][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;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][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;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][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;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][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 in interface RetryConfigOrBuilderpublic 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;hasMinBackoffDuration in interface RetryConfigOrBuilderpublic 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;getMinBackoffDuration in interface RetryConfigOrBuilderpublic 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;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;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;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;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;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;getMinBackoffDurationOrBuilder in interface RetryConfigOrBuilderpublic 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;hasMaxBackoffDuration in interface RetryConfigOrBuilderpublic 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;getMaxBackoffDuration in interface RetryConfigOrBuilderpublic 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;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;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;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;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;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;getMaxBackoffDurationOrBuilder in interface RetryConfigOrBuilderpublic 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;getMaxDoublings in interface RetryConfigOrBuilderpublic RetryConfig.Builder setMaxDoublings(int value)
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;value - The maxDoublings to set.public RetryConfig.Builder 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 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;public final RetryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<RetryConfig.Builder>public final RetryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<RetryConfig.Builder>Copyright © 2022 Google LLC. All rights reserved.