schedule

schedule
schedule

Schedule represents the meta information required by the server to set resources in maintenance mode at the right interval/time. To construct specific schedules, please see some of the static helper utilities in this class.

JSON Example
{
    "hour": 0,
    "minuteOfTheHour": 0,
    "duration": 0,
    "scheduleType": "string",
    "recurrence": 0,
    "dayOfTheMonth": 0,
    "daysOfTheMonth": [
        "string"
    ],
    "weeksOfTheMonth": [
        "string"
    ],
    "daysOfTheWeek": [
        "string"
    ],
    "month": 0,
    "months": [
        0
    ],
    "startDate": "string",
    "expirationDate": "string",
    "timeZone": "string",
    "expireRuns": 0
}
integer As int32 As int32
hour
Required

The beginning hour of the schedule.

integer As int32 As int32
minuteOfTheHour
Required

The beginning minutes of the schedule.

integer As int32 As int32
duration
Required
Constraints: minimum: 1

Duration of the schedule in minutes.

string
scheduleType
Required

Schedule type

Possible values are : UNKNOWN, ONCE, DAILY, WEEKLY, MONTHLY, YEARLY,
integer As int32 As int32
recurrence
Optional
Constraints: minimum: 1

Configures how the schedule is repeated within the provided interval, e.g. if scheduleType = DAILY then setting recurrence = 2 would trigger the job every 2 days.
Applicable only when scheduleType = DAILY or scheduleType = WEEKLY.

integer As int32 As int32
dayOfTheMonth
Optional

Deprecated, will be removed after couple of releases.
Day of the month on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with daysOfTheMonth and weeksOfTheMonth.

array of string
daysOfTheMonth
Optional

The list of the days of the month on which the job should be triggered. Applicable values are {1,2,...,31,LAST}. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with dayOfTheMonth and weeksOfTheMonth.

array of string
weeksOfTheMonth
Optional

The list of the week indices of the month on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.

Possible values are : UNKNOWNN, FIRST, SECOND, THIRD, FOURTH, LAST,
array of string
daysOfTheWeek
Optional

Days of the week on which the job should be triggered. Must be specified only when scheduleType = WEEKLY or scheduleType = MONTHLY.
When scheduleType = MONTHLY this parameter is mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.

Possible values are : UNKNOWN, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
integer As int32 As int32
month
Optional

Deprecated, will be removed after couple of releases.
Month of the year on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with months.

array of integer
months
Optional

Months of the year on which the job should be triggered. Must be specified only when scheduleType = MONTHLY. Mutually exclusive with month.

string
startDate
Optional

Start date for the schedule. Should be in format MM/DD/YYYY and if not specified current date is used.

string
expirationDate
Optional

The expiration date of the schedule. Should be in format MM/DD/YYYY. Mutually exclusive with expireRuns and either of them should be always defined when scheduleType != ONCE.

string
timeZone
Optional

Time Zone of the schedule.
If not provided, defaults to the time of the VMware Cloud Foundation Operations server.

integer As int32 As int32
expireRuns
Optional

The number of run after which the schedule should expire. Mutually exclusive with expirationDate and either of them should be always defined when scheduleType != ONCE.

Property Of