Previous page

Next page

Locate page in Contents

Print this page

triggerType

Summary:

This is the base type defining the schedule policy. When adding a task to the scheduler, choose from one of the subtypes of this type depending on how and when you would like the task to be executed. See the sections that describe the subtypes of this type for the detailed descriptions and code example on how to compose a schedule.

Type specification:

Name

Min/Max

Type

Description

start_time

1..1

datetime_type

The date and time of a scheduler task activation.

The date portion is not necessarily when the trigger will fire. The actual firing date is determined by other schedule policy parameters.

The time portion determines the exact time when the task will be executed on the scheduled day(s).

end_time

0..1

datetime_type

The date and time of a scheduler task deactivation. If absent, the trigger will stay active indefinitely until it is disabled using the update call or removed from the scheduler using the remove call.

Subtypes:

once_triggerType

daily_triggerType

weekly_triggerType

monthly_triggerType

monthly_day_of_week_triggerType

Please send us your feedback on this help page