ScheduledTaskSpec

ScheduledTaskSpec
ScheduledTaskSpec

Parameters for scheduled task creation.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "scheduler": {
        "_typeName": "string",
        "activeTime": "string",
        "expireTime": "string"
    },
    "action": {
        "_typeName": "string"
    },
    "notification": "string"
}
string
name
Required

Name of the scheduled task.

string
description
Required

Description of the scheduled task.

boolean
enabled
Required

Flag to indicate whether the scheduled task is enabled or disabled.

TaskScheduler
scheduler
Required

The TaskScheduler data object is the base type for the scheduler objects.

The hierarchy of scheduler objects is as follows:

    TaskScheduler
        [AfterStartupTaskScheduler](../../data-structures/AfterStartupTaskScheduler/)
        [OnceTaskScheduler](../../data-structures/OnceTaskScheduler/)
        [RecurrentTaskScheduler](../../data-structures/RecurrentTaskScheduler/)
            [HourlyTaskScheduler](../../data-structures/HourlyTaskScheduler/)
                [DailyTaskScheduler](../../data-structures/DailyTaskScheduler/)
                    [WeeklyTaskScheduler](../../data-structures/WeeklyTaskScheduler/)
                    [MonthlyTaskScheduler](../../data-structures/MonthlyTaskScheduler/)
                        [MonthlyByDayTaskScheduler](../../data-structures/MonthlyByDayTaskScheduler/)
                        [MonthlyByWeekdayTaskScheduler](../../data-structures/MonthlyByWeekdayTaskScheduler/)

Use a scheduler object to set the time(s) for task execution. You can use two scheduling modes - single execution or recurring execution:

  • Use the AfterStartupTaskScheduler or the OnceTaskScheduler to schedule a single instance of task execution.
  • Use one of the recurrent task schedulers to schedule hourly, daily, weekly, or monthly task execution.

After you have established the task timing, use the scheduler object for the ScheduledTaskSpec scheduler property value.

Action
action
Required

This data object type defines the action initiated by a scheduled task or alarm.

This is an abstract type. A client creates a scheduled task or an alarm each of which triggers an action, defined by a subclass of this type.

string
notification
Optional

The email notification.

If not set, this property is set to empty string, indicating no notification.

Property Of
Used By