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

    Interface FileVersion

    Complete metadata for a concrete file version in B2. Returned by b2_get_file_info, b2_upload_file, b2_copy_file, b2_hide_file, and other file-related endpoints. List endpoints return ListedFileVersion for file-name listings and ListedConcreteFileVersion for file-version listings unless a delimiter is requested, in which case file-name listings return FileNameListEntry and file-version listings return FileVersionListEntry.

    interface FileVersion {
        accountId: AccountId;
        action: ConcreteFileAction;
        bucketId: BucketId;
        contentLength: number;
        contentMd5: string | null;
        contentSha1: string | null;
        contentType: string;
        fileId: FileId;
        fileInfo: Record<string, string>;
        fileName: string;
        fileRetention: {
            isClientAuthorizedToRead: boolean;
            value: FileRetentionValue | null;
        };
        legalHold: {
            isClientAuthorizedToRead: boolean;
            value: LegalHoldValue
            | null;
        };
        replicationStatus?: ReplicationStatus;
        serverSideEncryption: PublicEncryptionSetting;
        uploadTimestamp: number;
    }
    Index
    accountId action bucketId contentLength contentMd5 contentSha1 contentType fileId fileInfo fileName fileRetention legalHold replicationStatus? serverSideEncryption uploadTimestamp
    accountId: AccountId

    Account that owns this file.

    action: ConcreteFileAction

    Action that created this file version.

    bucketId: BucketId

    Bucket containing this file.

    contentLength: number

    Size of the file content in bytes.

    contentMd5: string | null

    MD5 checksum of the content, or null if not available.

    contentSha1: string | null

    SHA-1 checksum of the content, or null if not available (e.g., large files).

    contentType: string

    MIME type of the file content.

    fileId: FileId

    Unique identifier for this file version.

    fileInfo: Record<string, string>

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

    fileName: string

    Full path and name of the file within the bucket.

    fileRetention: {
        isClientAuthorizedToRead: boolean;
        value: FileRetentionValue | null;
    }

    Object Lock retention settings for this file version.

    Type Declaration

    • ReadonlyisClientAuthorizedToRead: boolean

      Whether the caller is authorized to read retention settings.

    • Readonlyvalue: FileRetentionValue | null

      Retention settings, or null if the caller lacks read authorization.

    legalHold: { isClientAuthorizedToRead: boolean; value: LegalHoldValue | null }

    Legal hold status for this file version.

    Type Declaration

    • ReadonlyisClientAuthorizedToRead: boolean

      Whether the caller is authorized to read legal hold status.

    • Readonlyvalue: LegalHoldValue | null

      Legal hold value, or null if the caller lacks read authorization.

    replicationStatus?: ReplicationStatus

    Replication status when this file is covered by a replication rule.

    serverSideEncryption: PublicEncryptionSetting

    Server-side encryption settings applied to this file version.

    uploadTimestamp: number

    UTC timestamp (milliseconds) when this version was uploaded.

    Settings
    Member Visibility

    On This Page
    Properties