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

    Interface ParsedInputs

    The fully-parsed, fully-validated action surface. Built by parseInputs from INPUT_* env vars (via @actions/core); every command in src/commands/ consumes a frozen instance of this shape.

    Most fields map 1:1 to inputs declared in action.yml. Defaults and optionality match the YAML surface; see action.yml for the user-facing documentation per input.

    interface ParsedInputs {
        action: ActionName;
        applicationKey: string;
        applicationKeyId: string;
        bucket: string;
        bypassGovernance: boolean;
        compareMode: CompareMode;
        concurrency: number;
        contentType: string | undefined;
        destination: string | undefined;
        dryRun: boolean;
        encryption: EncryptionSetting | undefined;
        endpoint: string | undefined;
        exclude: string[];
        expectedSha1: string | undefined;
        failOnEmpty: boolean;
        include: string[];
        keepMode: KeepMode;
        legalHold: LegalHold | undefined;
        maxResults: number;
        partSize: number | undefined;
        presignTtlSeconds: number;
        resume: boolean;
        retentionMode: RetentionMode | undefined;
        retentionUntil: string | undefined;
        source: string | undefined;
        sourceBucket: string | undefined;
        sse: string | undefined;
        syncDirection: SyncDirection;
    }
    Index

    Properties

    action applicationKey applicationKeyId bucket bypassGovernance compareMode concurrency contentType destination dryRun encryption endpoint exclude expectedSha1 failOnEmpty include keepMode legalHold maxResults partSize presignTtlSeconds resume retentionMode retentionUntil source sourceBucket sse syncDirection

    Properties

    action: ActionName

    Which verb to dispatch to.

    applicationKey: string

    B2 application key (the secret). Masked at parse time via core.setSecret.

    applicationKeyId: string

    B2 application key ID. Masked at parse time via core.setSecret (defense in depth).

    bucket: string

    Destination bucket name for the action.

    bypassGovernance: boolean

    Allow shortening a governance-mode retention (requires key capability).

    compareMode: CompareMode

    How sync compares files.

    concurrency: number

    Parallel parts/files for upload/sync.

    contentType: string | undefined

    Content-Type to set on uploaded objects. Undefined leaves B2's auto-detect.

    destination: string | undefined

    Verb-dependent destination. Upload/sync: B2 file name or prefix. Download: local path. Copy: destination file name. Other verbs: ignored.

    dryRun: boolean

    Preview without executing (sync/delete/purge).

    encryption: EncryptionSetting | undefined

    Parsed SSE specification ready to hand to the SDK.

    endpoint: string | undefined

    Override B2 realm endpoint for staging / custom realms.

    exclude: string[]

    Glob patterns to exclude during upload/sync expansion. Default: .git/**.

    expectedSha1: string | undefined

    Literal SHA-1 to compare against in verify (when set, no local read).

    failOnEmpty: boolean

    Fail the action when upload/sync matches zero files.

    include: string[]

    Glob patterns to include during upload/sync expansion.

    keepMode: KeepMode

    How sync treats destination-only files.

    legalHold: LegalHold | undefined

    Legal-hold state to apply (retention verb).

    maxResults: number

    Cap on listed/presigned entries for list and prefix presign.

    partSize: number | undefined

    Multipart part size in bytes. Undefined defers to the SDK's recommendation.

    presignTtlSeconds: number

    Presigned-URL TTL in seconds.

    resume: boolean

    Resume an in-progress multipart upload.

    retentionMode: RetentionMode | undefined

    Object Lock retention mode to apply (retention verb).

    retentionUntil: string | undefined

    ISO-8601 timestamp until which retention applies. Required with retentionMode.

    source: string | undefined

    Verb-dependent source. Upload/sync: a local path or glob. Download/copy/ delete/presign/list/hide/unhide/verify/retention/head/purge: a B2 file name or prefix (trailing / means prefix mode for verbs that support it).

    sourceBucket: string | undefined

    Cross-bucket copy source bucket. Undefined means same-bucket copy.

    sse: string | undefined

    Raw sse: input value as the user typed it. Retained for diagnostics.

    syncDirection: SyncDirection

    Direction of a sync (auto-detected when set to auto).

    Settings

    Member Visibility

    On This Page

    Properties