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
MAX_DOUBLINGS_FIELD_NUMBER
public static final int MAX_DOUBLINGS_FIELD_NUMBER
Field Value
MAX_RETRY_DURATION_FIELD_NUMBER
public static final int MAX_RETRY_DURATION_FIELD_NUMBER
Field Value
MIN_BACKOFF_DURATION_FIELD_NUMBER
public static final int MIN_BACKOFF_DURATION_FIELD_NUMBER
Field Value
RETRY_COUNT_FIELD_NUMBER
public static final int RETRY_COUNT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RetryConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RetryConfig.Builder newBuilder()
Returns
newBuilder(RetryConfig prototype)
public static RetryConfig.Builder newBuilder(RetryConfig prototype)
Parameter
Returns
public static RetryConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RetryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RetryConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RetryConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RetryConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RetryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RetryConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RetryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RetryConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RetryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RetryConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public RetryConfig getDefaultInstanceForType()
Returns
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;
| 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;
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;
| 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;
| 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;
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;
| 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;
getParserForType()
public Parser<RetryConfig> getParserForType()
Returns
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;
| Type | Description |
| int | The retryCount.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the minBackoffDuration field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RetryConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RetryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RetryConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
