Class RetryConfig (2.44.0)

public final class RetryConfig extends GeneratedMessageV3 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.

Protobuf type google.cloud.scheduler.v1.RetryConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RetryConfig

Implements

RetryConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

MAX_BACKOFF_DURATION_FIELD_NUMBER

public static final int MAX_BACKOFF_DURATION_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_DOUBLINGS_FIELD_NUMBER

public static final int MAX_DOUBLINGS_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_RETRY_DURATION_FIELD_NUMBER

public static final int MAX_RETRY_DURATION_FIELD_NUMBER

Field Value
Type	Description
`int`

MIN_BACKOFF_DURATION_FIELD_NUMBER

public static final int MIN_BACKOFF_DURATION_FIELD_NUMBER

Field Value
Type	Description
`int`

RETRY_COUNT_FIELD_NUMBER

public static final int RETRY_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static RetryConfig getDefaultInstance()

Returns
Type	Description
`RetryConfig`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static RetryConfig.Builder newBuilder()

Returns
Type	Description
`RetryConfig.Builder`

newBuilder(RetryConfig prototype)

public static RetryConfig.Builder newBuilder(RetryConfig prototype)

Parameter
Name	Description
`prototype`	`RetryConfig`

Returns
Type	Description
`RetryConfig.Builder`

parseDelimitedFrom(InputStream input)

public static RetryConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static RetryConfig parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static RetryConfig parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static RetryConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static RetryConfig parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static RetryConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RetryConfig`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<RetryConfig> parser()

Returns
Type	Description
`Parser<RetryConfig>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public RetryConfig getDefaultInstanceForType()

Returns
Type	Description
`RetryConfig`

getMaxBackoffDuration()

public 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
Type	Description
`Duration`	The maxBackoffDuration.

getMaxBackoffDurationOrBuilder()

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;

Returns
Type	Description
`DurationOrBuilder`

getMaxDoublings()

public int getMaxDoublings()

The time between retries will double max_doublings times.

A job's retry interval starts at min_backoff_duration, then doubles max_doublings times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times.

For example, if min_backoff_duration is 10s, 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 until the job has been attempted 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
Type	Description
`int`	The maxDoublings.

getMaxRetryDuration()

public Duration getMaxRetryDuration()

The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with 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
Type	Description
`Duration`	The maxRetryDuration.

getMaxRetryDurationOrBuilder()

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, 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
Type	Description
`DurationOrBuilder`

getMinBackoffDuration()

public 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
Type	Description
`Duration`	The minBackoffDuration.

getMinBackoffDurationOrBuilder()

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;

Returns
Type	Description
`DurationOrBuilder`

getParserForType()

public Parser<RetryConfig> getParserForType()

Returns
Type	Description
`Parser<RetryConfig>`

Overrides

GeneratedMessageV3.getParserForType()

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.

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
Type	Description
`int`	The retryCount.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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;

Returns
Type	Description
`boolean`	Whether the maxBackoffDuration field is set.

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, 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
Type	Description
`boolean`	Whether the maxRetryDuration field is set.

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;

Returns
Type	Description
`boolean`	Whether the minBackoffDuration field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public RetryConfig.Builder newBuilderForType()

Returns
Type	Description
`RetryConfig.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`RetryConfig.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public RetryConfig.Builder toBuilder()

Returns
Type	Description
`RetryConfig.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`