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

    Interface StorageProfile

    Represents a storage profile.

    interface StorageProfile {
        default?: boolean;
        id?: string;
        name?: string;
        options?: {
            bucketName: string;
            bucketRegion?: string;
            objectPrefix?: string;
        };
        type?: "awsS3"
        | "gcs"
        | "dolbyStorage";
    }
    Index

    Properties

    default? id? name? options? type?

    Properties

    default?: boolean

    Flag indicating if this is the default storage profile.

    id?: string

    Identifier of the storage profile.

    name?: string

    Name of the storage profile.

    options?: { bucketName: string; bucketRegion?: string; objectPrefix?: string }

    Storage profile options.

    Type Declaration

    • bucketName: string

      Name of bucket to upload clips to. Please ensure Dolby's service account is granted access.

    • OptionalbucketRegion?: string

      Region of the specified bucket. Required when using storageType awsS3.

    • OptionalobjectPrefix?: string

      Prefix to object when stored in bucket i.e. protocol://bucketName/objectPrefix/objectName.ext. objectName is either defined by a system assigned GUID or the user-specified clipName.

    type?: "awsS3" | "gcs" | "dolbyStorage"

    Type of storage.

    Settings

    Member Visibility

    On This Page

    Properties