SettingsDepotsSyncScheduleSchedule

The SyncSchedule.Schedule structure defines a schedule.


Properties

integer as int64
day_of_month Optional

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.


day_of_week Optional

The SyncSchedule.DayOfWeek enumerated type contains the supported days of the week.
SUNDAY : Sunday.
MONDAY : Monday.
TUESDAY : Tuesday.
WEDNESDAY : Wednesday.
THURSDAY : Thursday.
FRIDAY : Friday.
SATURDAY : Saturday.

Possible values are: SUNDAYMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAY


integer as int64
hour Optional

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.


integer as int64
minute Optional

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.


integer as int64
skip Optional

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.


type Required

The SyncSchedule.Recurrence enumerated type contains the supported values for how often to sync from online or UMDS depots.
HOURLY : Hourly.
DAILY : Daily.
WEEKLY : Weekly.
MONTHLY_BY_DAY : Monthly by day.

Possible values are: HOURLYDAILYWEEKLYMONTHLY_BY_DAY

JSON Example

{
	"type": "HOURLY"
}

Feedback

Was this page helpful?