Reference documentation and code samples for the Cloud Scheduler V1 Client class RetryConfig.
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.
Generated from protobuf message google.cloud.scheduler.v1.RetryConfig
Namespace
Google \ Cloud \ Scheduler \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ retry_count
int
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 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. 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.
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.
The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
↳ max_doublings
int
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 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.
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 0, a job attempt will not be retried if
it fails. Instead the Cloud Scheduler system will wait for the
next scheduled execution time. Setting retry_count to 0 does not prevent
failed jobs from running according to schedule after the failure.
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.
Returns
Type
Description
int
setRetryCount
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 0, a job attempt will not be retried if
it fails. Instead the Cloud Scheduler system will wait for the
next scheduled execution time. Setting retry_count to 0 does not prevent
failed jobs from running according to schedule after the failure.
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
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.
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.
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 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.
Returns
Type
Description
int
setMaxDoublings
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 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Scheduler V1 Client - Class RetryConfig (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig)\n- [2.0.4](/php/docs/reference/cloud-scheduler/2.0.4/V1.RetryConfig)\n- [1.10.5](/php/docs/reference/cloud-scheduler/1.10.5/V1.RetryConfig)\n- [1.9.4](/php/docs/reference/cloud-scheduler/1.9.4/V1.RetryConfig)\n- [1.8.3](/php/docs/reference/cloud-scheduler/1.8.3/V1.RetryConfig)\n- [1.7.1](/php/docs/reference/cloud-scheduler/1.7.1/V1.RetryConfig)\n- [1.6.8](/php/docs/reference/cloud-scheduler/1.6.8/V1.RetryConfig) \nReference documentation and code samples for the Cloud Scheduler V1 Client class RetryConfig.\n\nSettings that determine the retry behavior.\n\nBy default, if a job does not complete successfully (meaning that\nan acknowledgement is not received from the handler, then it will be retried\nwith exponential backoff according to the settings in\n[RetryConfig](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig).\n\nGenerated from protobuf message `google.cloud.scheduler.v1.RetryConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Scheduler \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getRetryCount\n\nThe number of attempts that the system will make to run a job using the\nexponential backoff procedure described by\n[max_doublings](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxDoublings__).\n\nThe default value of retry_count is zero.\nIf retry_count is 0, a job attempt will not be retried if\nit fails. Instead the Cloud Scheduler system will wait for the\nnext scheduled execution time. Setting retry_count to 0 does not prevent\nfailed jobs from running according to schedule after the failure.\nIf retry_count is set to a non-zero number then Cloud Scheduler\nwill retry failed attempts, using exponential backoff,\nretry_count times, or until the next scheduled execution time,\nwhichever comes first.\nValues greater than 5 and negative values are not allowed.\n\n### setRetryCount\n\nThe number of attempts that the system will make to run a job using the\nexponential backoff procedure described by\n[max_doublings](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxDoublings__).\n\nThe default value of retry_count is zero.\nIf retry_count is 0, a job attempt will not be retried if\nit fails. Instead the Cloud Scheduler system will wait for the\nnext scheduled execution time. Setting retry_count to 0 does not prevent\nfailed jobs from running according to schedule after the failure.\nIf retry_count is set to a non-zero number then Cloud Scheduler\nwill retry failed attempts, using exponential backoff,\nretry_count times, or until the next scheduled execution time,\nwhichever comes first.\nValues greater than 5 and negative values are not allowed.\n\n### getMaxRetryDuration\n\nThe time limit for retrying a failed job, measured from time when an\nexecution was first attempted. If specified with\n[retry_count](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getRetryCount__), the job\nwill be retried until both limits are reached.\n\nThe default value for max_retry_duration is zero, which means retry\nduration is unlimited.\n\n### hasMaxRetryDuration\n\n### clearMaxRetryDuration\n\n### setMaxRetryDuration\n\nThe time limit for retrying a failed job, measured from time when an\nexecution was first attempted. If specified with\n[retry_count](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getRetryCount__), the job\nwill be retried until both limits are reached.\n\nThe default value for max_retry_duration is zero, which means retry\nduration is unlimited.\n\n### getMinBackoffDuration\n\nThe minimum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 5 seconds.\n\n### hasMinBackoffDuration\n\n### clearMinBackoffDuration\n\n### setMinBackoffDuration\n\nThe minimum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 5 seconds.\n\n### getMaxBackoffDuration\n\nThe maximum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 1 hour.\n\n### hasMaxBackoffDuration\n\n### clearMaxBackoffDuration\n\n### setMaxBackoffDuration\n\nThe maximum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 1 hour.\n\n### getMaxDoublings\n\nThe time between retries will double `max_doublings` times.\n\nA job's retry interval starts at\n[min_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMinBackoffDuration__),\nthen doubles `max_doublings` times, then increases linearly, and finally\nretries at intervals of\n[max_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxBackoffDuration__)\nup to [retry_count](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getRetryCount__)\ntimes.\nFor example, if\n[min_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMinBackoffDuration__)\nis 10s,\n[max_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxBackoffDuration__)\nis 300s, and `max_doublings` is 3, then the job will first be retried in\n10s. The retry interval will double three times, and then increase linearly\nby 2\\^3 \\* 10s. Finally, the job will retry at intervals of\n[max_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxBackoffDuration__)\nuntil the job has been attempted\n[retry_count](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getRetryCount__) times.\nThus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,\n300s, ....\nThe default value of this field is 5.\n\n### setMaxDoublings\n\nThe time between retries will double `max_doublings` times.\n\nA job's retry interval starts at\n[min_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMinBackoffDuration__),\nthen doubles `max_doublings` times, then increases linearly, and finally\nretries at intervals of\n[max_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxBackoffDuration__)\nup to [retry_count](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getRetryCount__)\ntimes.\nFor example, if\n[min_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMinBackoffDuration__)\nis 10s,\n[max_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxBackoffDuration__)\nis 300s, and `max_doublings` is 3, then the job will first be retried in\n10s. The retry interval will double three times, and then increase linearly\nby 2\\^3 \\* 10s. Finally, the job will retry at intervals of\n[max_backoff_duration](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getMaxBackoffDuration__)\nuntil the job has been attempted\n[retry_count](/php/docs/reference/cloud-scheduler/latest/V1.RetryConfig#_Google_Cloud_Scheduler_V1_RetryConfig__getRetryCount__) times.\nThus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,\n300s, ....\nThe default value of this field is 5."]]
