@dolbyio/dolbyio-rest-apis-client - v6.0.0
    Preparing search index...

    Interface TranscoderSchedule

    Represents a cloud transcoder schedule.

    interface TranscoderSchedule {
        clientId?: string;
        description?: string;
        executions?: {
            executionStatus:
                | "Deleted"
                | "Pending"
                | "Running"
                | "Completed"
                | "NoAction"
                | "UnexpectedError"
                | "RemovedByScheduleUpdate";
            executionTime: string;
            scheduleType: "Start"
            | "Stop";
            transcoderId: string;
        }[];
        metadata?: { createdOn: string; lastModifiedOn: string };
        name: string;
        recurring?: {
            endDate?: string;
            frequency: {
                daysOfWeek:
                    | "Sunday"
                    | "Monday"
                    | "Tuesday"
                    | "Wednesday"
                    | "Thursday"
                    | "Friday"
                    | "Saturday";
                interval: "Daily"
                | "Weekly";
            };
        };
        scheduleId?: string;
        start?: string;
        status: "Active"
        | "Deleted"
        | "Inactive";
        stop?: string;
        transcoderIds?: string[];
    }
    Index

    Properties

    clientId? description? executions? metadata? name recurring? scheduleId? start? status stop? transcoderIds?

    Properties

    clientId?: string

    A field that can be used to associate particular schedules.

    description?: string

    The description of the schedule.

    executions?: {
        executionStatus:
            | "Deleted"
            | "Pending"
            | "Running"
            | "Completed"
            | "NoAction"
            | "UnexpectedError"
            | "RemovedByScheduleUpdate";
        executionTime: string;
        scheduleType: "Start"
        | "Stop";
        transcoderId: string;
    }[]

    The recent executions.

    Type Declaration

    • executionStatus:
          | "Deleted"
          | "Pending"
          | "Running"
          | "Completed"
          | "NoAction"
          | "UnexpectedError"
          | "RemovedByScheduleUpdate"

      Status of the execution.

    • executionTime: string

      Execution time.

    • scheduleType: "Start" | "Stop"

      Type of execution.

    • transcoderId: string

      Identifier of the transcoder.

    metadata?: { createdOn: string; lastModifiedOn: string }

    The start date and time of the schedule in the format of YYYY-MM-DDTHH:MM:SSZ.

    Type Declaration

    • createdOn: string

      When was the schedule created.

    • lastModifiedOn: string

      When was the schedule last modified.

    name: string

    The name of the schedule.

    recurring?: {
        endDate?: string;
        frequency: {
            daysOfWeek:
                | "Sunday"
                | "Monday"
                | "Tuesday"
                | "Wednesday"
                | "Thursday"
                | "Friday"
                | "Saturday";
            interval: "Daily"
            | "Weekly";
        };
    }

    Recurring information about the schedule.

    Type Declaration

    • OptionalendDate?: string

      When does the schedule stops.

    • frequency: {
          daysOfWeek:
              | "Sunday"
              | "Monday"
              | "Tuesday"
              | "Wednesday"
              | "Thursday"
              | "Friday"
              | "Saturday";
          interval: "Daily"
          | "Weekly";
      }

      The description of the frequency for the schedule.

      • daysOfWeek:
            | "Sunday"
            | "Monday"
            | "Tuesday"
            | "Wednesday"
            | "Thursday"
            | "Friday"
            | "Saturday"

        Days of the week to trigger the schedule.

      • interval: "Daily" | "Weekly"

        The interval of the schedule.

    scheduleId?: string

    Identifier of the schedule.

    start?: string

    The start date and time of the schedule in the format of YYYY-MM-DDTHH:MM:SSZ.

    status: "Active" | "Deleted" | "Inactive"

    The status of the schedule.

    stop?: string

    The stop date and time of the schedule in the format of YYYY-MM-DDTHH:MM:SSZ.

    transcoderIds?: string[]

    The Transcoder Ids to schedule for.

    Settings

    Member Visibility

    On This Page

    Properties