ScheduleRetryConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
Scheduler retry options. Applies only to scheduled functions.
Signature:
export interface ScheduleRetryConfig
Properties
ScheduleRetryConfig.maxBackoffDuration
The maximum amount of time to wait before retrying a job after it fails.
Signature:
maxBackoffDuration?: string | Expression<string> | ResetValue;
ScheduleRetryConfig.maxDoublings
The max number of backoff doubling applied at each retry.
Signature:
maxDoublings?: number | Expression<number> | ResetValue;
ScheduleRetryConfig.maxRetryDuration
The time limit for retrying a failed job, measured from time when an execution was first attempted.
If specified with ScheduleRetryConfig.retryCount, the job will be retried until both limits are reached.
Signature:
maxRetryDuration?: string | Expression<string> | ResetValue;
ScheduleRetryConfig.minBackoffDuration
The minimum amount of time to wait before retrying a job after it fails.
Signature:
minBackoffDuration?: string | Expression<string> | ResetValue;
ScheduleRetryConfig.retryCount
The number of attempts that the system will make to run a job using the exponential backoff procedure described by ScheduleRetryConfig.maxDoublings.
Signature:
retryCount?: number | Expression<number> | ResetValue;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-04-24 UTC.
[null,null,["Last updated 2023-04-24 UTC."],[],[],null,["# ScheduleRetryConfig interface\n\nScheduler retry options. Applies only to scheduled functions.\n\n**Signature:** \n\n export interface ScheduleRetryConfig \n\nProperties\n----------\n\n| Property | Type | Description |\n|---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [maxBackoffDuration](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigmaxbackoffduration) | string \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cstring\\\u003e \\| ResetValue | The maximum amount of time to wait before retrying a job after it fails. |\n| [maxDoublings](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigmaxdoublings) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | The max number of backoff doubling applied at each retry. |\n| [maxRetryDuration](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigmaxretryduration) | string \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cstring\\\u003e \\| ResetValue | The time limit for retrying a failed job, measured from time when an execution was first attempted.If specified with [ScheduleRetryConfig.retryCount](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigretrycount), the job will be retried until both limits are reached. |\n| [minBackoffDuration](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigminbackoffduration) | string \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cstring\\\u003e \\| ResetValue | The minimum amount of time to wait before retrying a job after it fails. |\n| [retryCount](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigretrycount) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | The number of attempts that the system will make to run a job using the exponential backoff procedure described by [ScheduleRetryConfig.maxDoublings](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigmaxdoublings). |\n\nScheduleRetryConfig.maxBackoffDuration\n--------------------------------------\n\nThe maximum amount of time to wait before retrying a job after it fails.\n\n**Signature:** \n\n maxBackoffDuration?: string | Expression\u003cstring\u003e | ResetValue;\n\nScheduleRetryConfig.maxDoublings\n--------------------------------\n\nThe max number of backoff doubling applied at each retry.\n\n**Signature:** \n\n maxDoublings?: number | Expression\u003cnumber\u003e | ResetValue;\n\nScheduleRetryConfig.maxRetryDuration\n------------------------------------\n\nThe time limit for retrying a failed job, measured from time when an execution was first attempted.\n\nIf specified with [ScheduleRetryConfig.retryCount](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigretrycount), the job will be retried until both limits are reached.\n\n**Signature:** \n\n maxRetryDuration?: string | Expression\u003cstring\u003e | ResetValue;\n\nScheduleRetryConfig.minBackoffDuration\n--------------------------------------\n\nThe minimum amount of time to wait before retrying a job after it fails.\n\n**Signature:** \n\n minBackoffDuration?: string | Expression\u003cstring\u003e | ResetValue;\n\nScheduleRetryConfig.retryCount\n------------------------------\n\nThe number of attempts that the system will make to run a job using the exponential backoff procedure described by [ScheduleRetryConfig.maxDoublings](./firebase-functions.scheduleretryconfig.md#scheduleretryconfigmaxdoublings).\n\n**Signature:** \n\n retryCount?: number | Expression\u003cnumber\u003e | ResetValue;"]]