TaskTriggerSpec

data class TaskTriggerSpec(val disabled: Boolean? = null, val maxRetries: Int? = null, val schedule: String? = null, val startTime: String? = null, val type: String)

Constructors

Link copied to clipboard
constructor(disabled: Boolean? = null, maxRetries: Int? = null, schedule: String? = null, startTime: String? = null, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val disabled: Boolean? = null

Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

Link copied to clipboard
val maxRetries: Int? = null

Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

Link copied to clipboard
val schedule: String? = null

Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.

Link copied to clipboard
val startTime: String? = null

The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.

Link copied to clipboard

Trigger type of the user-specified Task Possible values are: ON_DEMAND, RECURRING.