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

    Interface UpdateTranscoderScheduleRequest

    Represents a cloud transcoder schedule update request.

    interface UpdateTranscoderScheduleRequest {
        clientId?: string;
        description?: string;
        name?: string;
        recurring?: {
            frequency: {
                daysOfWeek:
                    | "Sunday"
                    | "Monday"
                    | "Tuesday"
                    | "Wednesday"
                    | "Thursday"
                    | "Friday"
                    | "Saturday";
                interval: "Daily"
                | "Weekly";
            };
        };
        start?: string;
        stop?: string;
        transcoderIds?: string[];
    }
    Index

    Properties

    clientId? description? name? recurring? start? stop? transcoderIds?

    Properties

    clientId?: string

    Update the customers reference field.

    description?: string

    Update the description of the schedule.

    name?: string

    Update display name for schedule.

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

    Update recurring schedule.

    Type Declaration

    • 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.

    start?: string

    Update the start date and time of the schedule in the format of YYYY-MM-DDTHH:MM:SSZ. If it's weekly, then we use the time from this as well and the first day to anchor the schedule.

    stop?: string

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

    transcoderIds?: string[]

    Update all transcoder Ids for the schedule. This replaces all existing transcoder Ids for the schedule.

    Settings

    Member Visibility

    On This Page

    Properties