Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 3 KB

Schedule.md

File metadata and controls

62 lines (49 loc) · 3 KB

Schedule

Properties

Name Type Description Notes
actionType ActionTypeEnum The type of action that the schedule should trigger on the transcoder. The default is start. [optional]
createdAt OffsetDateTime The date and time that the schedule was created. [optional]
endRepeat LocalDate The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD. [optional]
id String The unique alphanumeric string that identifies the schedule. [optional]
name String A descriptive name for the schedule. Maximum 255 characters. [optional]
recurrenceData RecurrenceDataEnum The day or days of the week that a recurring schedule should run. [optional]
recurrenceType RecurrenceTypeEnum A schedule can run one time only (once) or repeat (recur) until a specified end_repeat date. The default is once. [optional]
startRepeat LocalDate The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD. [optional]
startTranscoder OffsetDateTime The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. [optional]
state StateEnum A schedule must be enabled to run. Specify enabled to run the schedule or disabled to turn off the schedule so that it doesn't run. [optional]
stopTranscoder OffsetDateTime The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. [optional]
transcoderId String The unique alphanumeric string that identifies the transcoder being scheduled. [optional]
transcoderName String The name of the transcoder being scheduled. [optional]
updatedAt OffsetDateTime The date and time that the schedule was updated. [optional]

Enum: ActionTypeEnum

Name Value
START "start"
STOP "stop"
START_STOP "start_stop"

Enum: RecurrenceDataEnum

Name Value
SUNDAY "sunday"
MONDAY "monday"
TUESDAY "tuesday"
WEDNESDAY "wednesday"
THURSDAY "thursday"
FRIDAY "friday"
SATURDAY "saturday"

Enum: RecurrenceTypeEnum

Name Value
ONCE "once"
RECUR "recur"

Enum: StateEnum

Name Value
ENABLED "enabled"
DISABLED "disabled"
EXPIRED "expired"