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

    Interface CopyFileRequest

    Request parameters for the b2_copy_file API call. Performs a server-side file copy.

    interface CopyFileRequest {
        contentType?: string;
        destinationBucketId?: BucketId;
        destinationServerSideEncryption?: EncryptionSetting;
        fileInfo?: Record<string, string>;
        fileName: string;
        fileRetention?: FileRetentionValue;
        legalHold?: LegalHoldValue;
        metadataDirective?: MetadataDirective;
        range?: string;
        sourceFileId: FileId;
        sourceServerSideEncryption?: EncryptionSetting;
    }
    Index

    Properties

    contentType? destinationBucketId? destinationServerSideEncryption? fileInfo? fileName fileRetention? legalHold? metadataDirective? range? sourceFileId sourceServerSideEncryption?

    Properties

    contentType?: string

    MIME type for the destination file (only used when metadataDirective is 'REPLACE').

    destinationBucketId?: BucketId

    Destination bucket ID. Defaults to the source bucket if omitted.

    destinationServerSideEncryption?: EncryptionSetting

    Server-side encryption to apply to the destination file.

    fileInfo?: Record<string, string>

    User-defined metadata for the destination file (only used when metadataDirective is 'REPLACE').

    fileName: string

    Name for the destination file.

    fileRetention?: FileRetentionValue

    Object Lock retention for the destination file.

    legalHold?: LegalHoldValue

    Legal hold for the destination file.

    metadataDirective?: MetadataDirective

    Whether to copy or replace the source file's metadata.

    range?: string

    Byte range to copy (e.g., 'bytes=0-999'). Omit to copy the entire file.

    sourceFileId: FileId

    ID of the source file version to copy from.

    sourceServerSideEncryption?: EncryptionSetting

    SSE-C settings for reading the source file, if the source is encrypted with SSE-C.

    Settings

    Member Visibility

    On This Page

    Properties