ScheduleInput

ScheduleInput

Input for creating a new Schedule. All DateTime values follow the same
floating-time convention described on the Schedule type.

For fixed schedules: one or both of startDate and endDate must be set.
For recurring schedules: rrule and durationMinutes must be set.

Kind: Input

Fields

Definition

"""
Input for creating a new Schedule. All DateTime values follow the same
floating-time convention described on the Schedule type.

For fixed schedules: one or both of startDate and endDate must be set.
For recurring schedules: rrule and durationMinutes must be set.
"""
input ScheduleInput {
  """
  Duration of each recurring event in minutes (required if rrule is present).
  For example, a recurring event from 8am-9am local time can be represented by:
  {
    "rrule": "RRULE:FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
    "durationMinutes": 60
  }
  """
  durationMinutes: Int
  """
  When the schedule expires (null means no expiration). Stored as UTC but
  interpreted as a floating local time.
  """
  endDate: DateTime
  """
  Recurrence pattern (null means no recurrence). This follows the RRULE property
  format from iCalendar (RFC-5545). Note that there are redundant degrees of
  freedom between the rrule's UNTIL and COUNT rules and the endDate property on
  the Schedule type. In practice, the value resulting in the soonest expiration
  will take effect. Additional iCalendar properties (such as DTSTART) are not
  supported; to restrict the start date of a recurring event, use the startDate
  property.
  """
  rrule: RRule
  """
  When the resource becomes active (null means active from when the schedule is
  created). Stored as UTC but interpreted as a floating local time.
  """
  startDate: DateTime
}