@backblaze-labs/b2-sdk - v0.4.0
    Preparing search index...

    Interface StartLargeFileResponse

    Response from the b2_start_large_file API call.

    interface StartLargeFileResponse {
        accountId: string;
        action?: FileAction;
        bucketId: BucketId;
        contentLength?: number;
        contentMd5?: string | null;
        contentSha1?: string | null;
        contentType: string;
        fileId: LargeFileId;
        fileInfo: Record<string, string>;
        fileName: string;
        fileRetention?: ReadableFileRetention;
        legalHold?: ReadableLegalHold;
        replicationStatus?: ReplicationStatus;
        serverSideEncryption?: PublicEncryptionSetting;
        uploadTimestamp?: number;
    }

    Hierarchy (View Summary)

    Index
    accountId action? bucketId contentLength? contentMd5? contentSha1? contentType fileId fileInfo fileName fileRetention? legalHold? replicationStatus? serverSideEncryption? uploadTimestamp?
    accountId: string

    Account that owns this file.

    action?: FileAction

    Action that created this unfinished file version.

    bucketId: BucketId

    Bucket the file is being uploaded to.

    contentLength?: number

    When present, always 0 for unfinished large files.

    contentMd5?: string | null

    When present, always null for unfinished large files.

    contentSha1?: string | null

    When present for documented B2 unfinished large files, this is null: B2's 'none' wire sentinel is normalized to null. If B2 omits the field, it remains undefined; the string arm is retained for forward-compatible or non-standard response values.

    contentType: string

    MIME type of the file.

    fileId: LargeFileId

    ID assigned to this large file upload. Use this to upload parts and finish the file.

    fileInfo: Record<string, string>

    User-defined key-value metadata stored with the file.

    fileName: string

    Name of the file being uploaded.

    fileRetention?: ReadableFileRetention

    Object Lock retention settings for this unfinished file, when readable.

    legalHold?: ReadableLegalHold

    Legal hold status for this unfinished file, when readable.

    replicationStatus?: ReplicationStatus

    Uppercase B2 replication status when this unfinished file is covered by a replication rule.

    serverSideEncryption?: PublicEncryptionSetting

    Server-side encryption applied to this unfinished file.

    uploadTimestamp?: number

    UTC timestamp (milliseconds) when this unfinished upload was started.

    Settings
    Member Visibility

    On This Page
    Properties