scheduler.ScheduleOptions interface

Options that can be set on a Schedule trigger.

Signature:

exportinterfaceScheduleOptionsextendsoptions.GlobalOptions

Extends:options.GlobalOptions

Properties

PropertyTypeDescription
maxBackoffSecondsnumber | Expression<number> | ResetValueThe maximum time to wait before retrying.
maxDoublingsnumber | Expression<number> | ResetValueThe time between will double max doublings times.
maxRetrySecondsnumber | Expression<number> | ResetValueThe time limit for retrying.
minBackoffSecondsnumber | Expression<number> | ResetValueThe minimum time to wait before retying.
retryCountnumber | Expression<number> | ResetValueThe number of retry attempts for a failed run.
schedulestringThe schedule, in Unix Crontab or AppEngine syntax.
timeZonetimezone | Expression<string> | ResetValueThe 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;