scheduler.ScheduleOptions interface

Options that can be set on a Schedule trigger.

Signature:

export interface ScheduleOptions extends options.GlobalOptions 

Extends: options.GlobalOptions

Properties

Property Type Description
maxBackoffSeconds number | Expression<number> | ResetValue The maximum time to wait before retrying.
maxDoublings number | Expression<number> | ResetValue The time between will double max doublings times.
maxRetrySeconds number | Expression<number> | ResetValue The time limit for retrying.
minBackoffSeconds number | Expression<number> | ResetValue The minimum time to wait before retying.
retryCount number | Expression<number> | ResetValue The number of retry attempts for a failed run.
schedule string The schedule, in Unix Crontab or AppEngine syntax.
timeZone timezone | Expression<string> | ResetValue The timezone that the schedule executes in.

scheduler.ScheduleOptions.maxBackoffSeconds

The maximum time to wait before retrying.

Signature:

maxBackoffSeconds?: number | Expression<number> | ResetValue;

scheduler.ScheduleOptions.maxDoublings

The time between will double max doublings times.

Signature:

maxDoublings?: number | Expression<number> | ResetValue;

scheduler.ScheduleOptions.maxRetrySeconds

The time limit for retrying.

Signature:

maxRetrySeconds?: number | Expression<number> | ResetValue;

scheduler.ScheduleOptions.minBackoffSeconds

The minimum time to wait before retying.

Signature:

minBackoffSeconds?: number | Expression<number> | ResetValue;

scheduler.ScheduleOptions.retryCount

The number of retry attempts for a failed run.

Signature:

retryCount?: number | Expression<number> | ResetValue;

scheduler.ScheduleOptions.schedule

The schedule, in Unix Crontab or AppEngine syntax.

Signature:

schedule: string;

scheduler.ScheduleOptions.timeZone

The timezone that the schedule executes in.

Signature:

timeZone?: timezone | Expression<string> | ResetValue;