public final class RetryConfig extends com.google.protobuf.GeneratedMessageV3 implements RetryConfigOrBuilder
Retry config. These settings determine when a failed task attempt is retried.Protobuf type
google.cloud.tasks.v2.RetryConfig| Modifier and Type | Class and Description |
|---|---|
static class |
RetryConfig.Builder
Retry config.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
MAX_ATTEMPTS_FIELD_NUMBER |
static int |
MAX_BACKOFF_FIELD_NUMBER |
static int |
MAX_DOUBLINGS_FIELD_NUMBER |
static int |
MAX_RETRY_DURATION_FIELD_NUMBER |
static int |
MIN_BACKOFF_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static RetryConfig |
getDefaultInstance() |
RetryConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
int |
getMaxAttempts()
Number of attempts per task.
|
com.google.protobuf.Duration |
getMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
|
com.google.protobuf.DurationOrBuilder |
getMaxBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
|
int |
getMaxDoublings()
The time between retries will double `max_doublings` times.
|
com.google.protobuf.Duration |
getMaxRetryDuration()
If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted.
|
com.google.protobuf.DurationOrBuilder |
getMaxRetryDurationOrBuilder()
If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted.
|
com.google.protobuf.Duration |
getMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
|
com.google.protobuf.DurationOrBuilder |
getMinBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
|
com.google.protobuf.Parser<RetryConfig> |
getParserForType() |
int |
getSerializedSize() |
int |
hashCode() |
boolean |
hasMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
|
boolean |
hasMaxRetryDuration()
If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted.
|
boolean |
hasMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
should be retried.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static RetryConfig.Builder |
newBuilder() |
static RetryConfig.Builder |
newBuilder(RetryConfig prototype) |
RetryConfig.Builder |
newBuilderForType() |
protected RetryConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static RetryConfig |
parseDelimitedFrom(InputStream input) |
static RetryConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(byte[] data) |
static RetryConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(ByteBuffer data) |
static RetryConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(com.google.protobuf.ByteString data) |
static RetryConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RetryConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(InputStream input) |
static RetryConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RetryConfig> |
parser() |
RetryConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int MAX_ATTEMPTS_FIELD_NUMBER
public static final int MAX_RETRY_DURATION_FIELD_NUMBER
public static final int MIN_BACKOFF_FIELD_NUMBER
public static final int MAX_BACKOFF_FIELD_NUMBER
public static final int MAX_DOUBLINGS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getMaxAttempts()
Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
int32 max_attempts = 1;getMaxAttempts in interface RetryConfigOrBuilderpublic boolean hasMaxRetryDuration()
If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration max_retry_duration = 2;hasMaxRetryDuration in interface RetryConfigOrBuilderpublic com.google.protobuf.Duration getMaxRetryDuration()
If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration max_retry_duration = 2;getMaxRetryDuration in interface RetryConfigOrBuilderpublic com.google.protobuf.DurationOrBuilder getMaxRetryDurationOrBuilder()
If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration max_retry_duration = 2;getMaxRetryDurationOrBuilder in interface RetryConfigOrBuilderpublic boolean hasMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration min_backoff = 3;hasMinBackoff in interface RetryConfigOrBuilderpublic com.google.protobuf.Duration getMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration min_backoff = 3;getMinBackoff in interface RetryConfigOrBuilderpublic com.google.protobuf.DurationOrBuilder getMinBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration min_backoff = 3;getMinBackoffOrBuilder in interface RetryConfigOrBuilderpublic boolean hasMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration max_backoff = 4;hasMaxBackoff in interface RetryConfigOrBuilderpublic com.google.protobuf.Duration getMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration max_backoff = 4;getMaxBackoff in interface RetryConfigOrBuilderpublic com.google.protobuf.DurationOrBuilder getMaxBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
.google.protobuf.Duration max_backoff = 4;getMaxBackoffOrBuilder in interface RetryConfigOrBuilderpublic int getMaxDoublings()
The time between retries will double `max_doublings` times. A task's retry interval starts at [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff], then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] up to [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times. For example, if [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] is 10s, [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] until the task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
int32 max_doublings = 5;getMaxDoublings in interface RetryConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RetryConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RetryConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static RetryConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RetryConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RetryConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RetryConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RetryConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RetryConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RetryConfig.Builder newBuilder()
public static RetryConfig.Builder newBuilder(RetryConfig prototype)
public RetryConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RetryConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RetryConfig getDefaultInstance()
public static com.google.protobuf.Parser<RetryConfig> parser()
public com.google.protobuf.Parser<RetryConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RetryConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.