tasks.RetryConfig interface
Stay organized with collections
Save and categorize content based on your preferences.
How a task should be retried in the event of a non-2xx return.
Signature:
export interface RetryConfig
Properties
Property |
Type |
Description |
maxAttempts |
number | Expression<number> | ResetValue |
Maximum number of times a request should be attempted. If left unspecified, will default to 3. |
maxBackoffSeconds |
number | Expression<number> | ResetValue |
The maximum amount of time to wait between attempts. If left unspecified will default to 1hr. |
maxDoublings |
number | Expression<number> | ResetValue |
The maximum number of times to double the backoff between retries. If left unspecified will default to 16. |
maxRetrySeconds |
number | Expression<number> | ResetValue |
Maximum amount of time for retrying failed task. If left unspecified will retry indefinitely. |
minBackoffSeconds |
number | Expression<number> | ResetValue |
The minimum time to wait between attempts. If left unspecified will default to 100ms. |
tasks.RetryConfig.maxAttempts
Maximum number of times a request should be attempted. If left unspecified, will default to 3.
Signature:
maxAttempts?: number | Expression<number> | ResetValue;
tasks.RetryConfig.maxBackoffSeconds
The maximum amount of time to wait between attempts. If left unspecified will default to 1hr.
Signature:
maxBackoffSeconds?: number | Expression<number> | ResetValue;
tasks.RetryConfig.maxDoublings
The maximum number of times to double the backoff between retries. If left unspecified will default to 16.
Signature:
maxDoublings?: number | Expression<number> | ResetValue;
tasks.RetryConfig.maxRetrySeconds
Maximum amount of time for retrying failed task. If left unspecified will retry indefinitely.
Signature:
maxRetrySeconds?: number | Expression<number> | ResetValue;
tasks.RetryConfig.minBackoffSeconds
The minimum time to wait between attempts. If left unspecified will default to 100ms.
Signature:
minBackoffSeconds?: 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-05-09 UTC.
[null,null,["Last updated 2023-05-09 UTC."],[],[],null,["# tasks.RetryConfig interface\n\nHow a task should be retried in the event of a non-2xx return.\n\n**Signature:** \n\n export interface RetryConfig \n\nProperties\n----------\n\n| Property | Type | Description |\n|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|\n| [maxAttempts](./firebase-functions.tasks.retryconfig.md#tasksretryconfigmaxattempts) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | Maximum number of times a request should be attempted. If left unspecified, will default to 3. |\n| [maxBackoffSeconds](./firebase-functions.tasks.retryconfig.md#tasksretryconfigmaxbackoffseconds) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | The maximum amount of time to wait between attempts. If left unspecified will default to 1hr. |\n| [maxDoublings](./firebase-functions.tasks.retryconfig.md#tasksretryconfigmaxdoublings) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | The maximum number of times to double the backoff between retries. If left unspecified will default to 16. |\n| [maxRetrySeconds](./firebase-functions.tasks.retryconfig.md#tasksretryconfigmaxretryseconds) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | Maximum amount of time for retrying failed task. If left unspecified will retry indefinitely. |\n| [minBackoffSeconds](./firebase-functions.tasks.retryconfig.md#tasksretryconfigminbackoffseconds) | number \\| [Expression](./firebase-functions.params.expression.md#paramsexpression_class)\\\u003cnumber\\\u003e \\| ResetValue | The minimum time to wait between attempts. If left unspecified will default to 100ms. |\n\ntasks.RetryConfig.maxAttempts\n-----------------------------\n\nMaximum number of times a request should be attempted. If left unspecified, will default to 3.\n\n**Signature:** \n\n maxAttempts?: number | Expression\u003cnumber\u003e | ResetValue;\n\ntasks.RetryConfig.maxBackoffSeconds\n-----------------------------------\n\nThe maximum amount of time to wait between attempts. If left unspecified will default to 1hr.\n\n**Signature:** \n\n maxBackoffSeconds?: number | Expression\u003cnumber\u003e | ResetValue;\n\ntasks.RetryConfig.maxDoublings\n------------------------------\n\nThe maximum number of times to double the backoff between retries. If left unspecified will default to 16.\n\n**Signature:** \n\n maxDoublings?: number | Expression\u003cnumber\u003e | ResetValue;\n\ntasks.RetryConfig.maxRetrySeconds\n---------------------------------\n\nMaximum amount of time for retrying failed task. If left unspecified will retry indefinitely.\n\n**Signature:** \n\n maxRetrySeconds?: number | Expression\u003cnumber\u003e | ResetValue;\n\ntasks.RetryConfig.minBackoffSeconds\n-----------------------------------\n\nThe minimum time to wait between attempts. If left unspecified will default to 100ms.\n\n**Signature:** \n\n minBackoffSeconds?: number | Expression\u003cnumber\u003e | ResetValue;"]]