backblaze-labs/b2-action - v0.1.0
    Preparing search index...

    Interface RetentionResult

    Result of retentionCommand: describes what was applied to the target version.

    interface RetentionResult {
        appliedLegalHold: "on" | "off" | undefined;
        appliedMode: "none" | "compliance" | "governance" | undefined;
        fileId: string;
        fileName: string;
        retainUntilTimestamp: number | null | undefined;
    }
    Index

    Properties

    appliedLegalHold appliedMode fileId fileName retainUntilTimestamp

    Properties

    appliedLegalHold: "on" | "off" | undefined

    Legal-hold state after the call. Undefined when not touched by this invocation.

    appliedMode: "none" | "compliance" | "governance" | undefined

    Retention mode after the call. none means retention was cleared. Undefined if only legal-hold was touched.

    fileId: string

    B2 file ID of the version that was modified.

    fileName: string

    B2 file name the retention/hold was applied to.

    retainUntilTimestamp: number | null | undefined

    Retention expiration timestamp (ms since the epoch). null when mode is none.

    Settings

    Member Visibility

    On This Page

    Properties