Class RetryConfig (2.2.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

Static Fields

MAX_BACKOFF_DURATION_FIELD_NUMBER

public static final int MAX_BACKOFF_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_DOUBLINGS_FIELD_NUMBER

public static final int MAX_DOUBLINGS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_RETRY_DURATION_FIELD_NUMBER

public static final int MAX_RETRY_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_BACKOFF_DURATION_FIELD_NUMBER

public static final int MIN_BACKOFF_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

RETRY_COUNT_FIELD_NUMBER

public static final int RETRY_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RetryConfig getDefaultInstance()
Returns
TypeDescription
RetryConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RetryConfig.Builder newBuilder()
Returns
TypeDescription
RetryConfig.Builder

newBuilder(RetryConfig prototype)

public static RetryConfig.Builder newBuilder(RetryConfig prototype)
Parameter
NameDescription
prototypeRetryConfig
Returns
TypeDescription
RetryConfig.Builder

parseDelimitedFrom(InputStream input)

public static RetryConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RetryConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetryConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetryConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RetryConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RetryConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RetryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RetryConfig> parser()
Returns
TypeDescription
Parser<RetryConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RetryConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<RetryConfig> getParserForType()
Returns
TypeDescription
Parser<RetryConfig>
Overrides

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
TypeDescription
int

The retryCount.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the minBackoffDuration field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RetryConfig.Builder newBuilderForType()
Returns
TypeDescription
RetryConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RetryConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RetryConfig.Builder toBuilder()
Returns
TypeDescription
RetryConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException