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

    Interface StartLargeFileRequest

    Request parameters for the b2_start_large_file API call. Initiates a multi-part upload.

    interface StartLargeFileRequest {
        bucketId: BucketId;
        contentType: string;
        customUploadTimestamp?: string | null;
        fileInfo?: Record<string, string>;
        fileName: string;
        fileRetention?: FileRetentionValue;
        legalHold?: LegalHoldValue;
        serverSideEncryption?: EncryptionSetting;
    }
    Index
    bucketId contentType customUploadTimestamp? fileInfo? fileName fileRetention? legalHold? serverSideEncryption?
    bucketId: BucketId

    Bucket to upload the large file to.

    contentType: string

    MIME type of the file. Use 'b2/x-auto' for automatic detection.

    customUploadTimestamp?: string | null

    Optional B2 upload timestamp override in milliseconds since epoch, as a decimal string. null is accepted and ignored by B2. Sets the file version uploadTimestamp; distinct from src_last_modified_millis metadata. Requires B2 account enablement for Custom Upload Timestamp.

    fileInfo?: Record<string, string>

    Optional user-defined key-value metadata for the file.

    fileName: string

    Full path and name of the file within the bucket.

    fileRetention?: FileRetentionValue

    Optional Object Lock retention for the file.

    legalHold?: LegalHoldValue

    Optional legal hold for the file.

    serverSideEncryption?: EncryptionSetting

    Optional server-side encryption setting.

    Settings
    Member Visibility

    On This Page
    Properties