public final class RetryConfig extends GeneratedMessageV3 implements RetryConfigOrBuilder
Retry config. These settings determine how a failed task attempt is retried.Protobuf type
google.cloud.tasks.v2beta2.RetryConfig
Modifier and Type | Class and Description |
---|---|
static class |
RetryConfig.Builder
Retry config.
|
static class |
RetryConfig.NumAttemptsCase |
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
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 |
static int |
UNLIMITED_ATTEMPTS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
static RetryConfig |
getDefaultInstance() |
RetryConfig |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
int |
getMaxAttempts()
The maximum number of attempts for a task.
|
Duration |
getMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
retried.
|
DurationOrBuilder |
getMaxBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
retried.
|
int |
getMaxDoublings()
The time between retries will double `max_doublings` times.
|
Duration |
getMaxRetryDuration()
If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted.
|
DurationOrBuilder |
getMaxRetryDurationOrBuilder()
If positive, `max_retry_duration` specifies the time limit for
retrying a failed task, measured from when the task was first
attempted.
|
Duration |
getMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
retried.
|
DurationOrBuilder |
getMinBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
retried.
|
RetryConfig.NumAttemptsCase |
getNumAttemptsCase() |
Parser<RetryConfig> |
getParserForType() |
int |
getSerializedSize() |
UnknownFieldSet |
getUnknownFields() |
boolean |
getUnlimitedAttempts()
If true, then the number of attempts is unlimited.
|
int |
hashCode() |
boolean |
hasMaxAttempts()
The maximum number of attempts for a task.
|
boolean |
hasMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2beta2.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.v2beta2.Task.schedule_time] for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
retried.
|
boolean |
hasUnlimitedAttempts()
If true, then the number of attempts is unlimited.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static RetryConfig.Builder |
newBuilder() |
static RetryConfig.Builder |
newBuilder(RetryConfig prototype) |
RetryConfig.Builder |
newBuilderForType() |
protected RetryConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static RetryConfig |
parseDelimitedFrom(InputStream input) |
static RetryConfig |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(byte[] data) |
static RetryConfig |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(ByteBuffer data) |
static RetryConfig |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(ByteString data) |
static RetryConfig |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(CodedInputStream input) |
static RetryConfig |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static RetryConfig |
parseFrom(InputStream input) |
static RetryConfig |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<RetryConfig> |
parser() |
RetryConfig.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int MAX_ATTEMPTS_FIELD_NUMBER
public static final int UNLIMITED_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(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public RetryConfig.NumAttemptsCase getNumAttemptsCase()
getNumAttemptsCase
in interface RetryConfigOrBuilder
public boolean hasMaxAttempts()
The maximum number of attempts for a 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 > 0.
int32 max_attempts = 1;
hasMaxAttempts
in interface RetryConfigOrBuilder
public int getMaxAttempts()
The maximum number of attempts for a 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 > 0.
int32 max_attempts = 1;
getMaxAttempts
in interface RetryConfigOrBuilder
public boolean hasUnlimitedAttempts()
If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
hasUnlimitedAttempts
in interface RetryConfigOrBuilder
public boolean getUnlimitedAttempts()
If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
getUnlimitedAttempts
in interface RetryConfigOrBuilder
public 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.v2beta2.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. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 3;
hasMaxRetryDuration
in interface RetryConfigOrBuilder
public 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.v2beta2.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. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 3;
getMaxRetryDuration
in interface RetryConfigOrBuilder
public 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.v2beta2.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. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 3;
getMaxRetryDurationOrBuilder
in interface RetryConfigOrBuilder
public boolean hasMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 4;
hasMinBackoff
in interface RetryConfigOrBuilder
public Duration getMinBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 4;
getMinBackoff
in interface RetryConfigOrBuilder
public DurationOrBuilder getMinBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 4;
getMinBackoffOrBuilder
in interface RetryConfigOrBuilder
public boolean hasMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 5;
hasMaxBackoff
in interface RetryConfigOrBuilder
public Duration getMaxBackoff()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 5;
getMaxBackoff
in interface RetryConfigOrBuilder
public DurationOrBuilder getMaxBackoffOrBuilder()
A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. `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 = 5;
getMaxBackoffOrBuilder
in interface RetryConfigOrBuilder
public int getMaxDoublings()
The time between retries will double `max_doublings` times. A task's retry interval starts at [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times. For example, if [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s, [max_backoff][google.cloud.tasks.v2beta2.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.v2beta2.RetryConfig.max_backoff] until the task has been attempted [max_attempts][google.cloud.tasks.v2beta2.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 is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. 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 = 6;
getMaxDoublings
in interface RetryConfigOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static RetryConfig parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static RetryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static RetryConfig parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static RetryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static RetryConfig parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static RetryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static RetryConfig parseFrom(InputStream input) throws IOException
IOException
public static RetryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static RetryConfig parseDelimitedFrom(InputStream input) throws IOException
IOException
public static RetryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static RetryConfig parseFrom(CodedInputStream input) throws IOException
IOException
public static RetryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public RetryConfig.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static RetryConfig.Builder newBuilder()
public static RetryConfig.Builder newBuilder(RetryConfig prototype)
public RetryConfig.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected RetryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static RetryConfig getDefaultInstance()
public static Parser<RetryConfig> parser()
public Parser<RetryConfig> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public RetryConfig getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.