Developer Documentation

SyncScheduleSchedule

The SyncSchedule.Schedule structure defines a schedule.


Properties

Required Property Name Type Description
optional day_of_month integer

Day at which schedule should be run. The value must be within the range 1 to 31. If the value exceeds the total number of days in the month, the schedule will run on the last day of the month. This field is optional and it is only relevant when the value of SyncSchedule.Schedule.type is MONTHLY_BY_DAY.

optional day_of_week SyncScheduleDayOfWeek Enum

Day of the week when schedule should be run This field is optional and it is only relevant when the value of SyncSchedule.Schedule.type is WEEKLY.

optional hour integer

Hour at which schedule should be run. The value must be within the range 0 to 23. This field is optional and it is only relevant when the value of SyncSchedule.Schedule.type is one of DAILY, WEEKLY, or MONTHLY_BY_DAY.

optional minute integer

Minute at which schedule should be run. The value must be within the range 0 to 59. This field is optional and it is only relevant when the value of SyncSchedule.Schedule.type is one of HOURLY, DAILY, WEEKLY, or MONTHLY_BY_DAY.

optional skip integer

This determines the units of SyncSchedule.Recurrence to skip before the scheduled task runs again. For example, value of 1 for HOURLY type means the scheduled task runs every 2 hours. The value must be within the range 0 to 998. If unset, no unit is skipped.

required type SyncScheduleRecurrence Enum

Frequency of the schedule.

Feedback

Was this page helpful?