Class ArtifactsClient

sdk.artifacts — mint/poll the artifact ingest session, register the delivered digest, and probe presence (see module doc). Idempotent by digest.

Index

Constructors

Methods

createUpload get getUpload register

Constructors

constructor

new ArtifactsClient(call: Caller): ArtifactsClient
Parameters
- call: Caller
Returns ArtifactsClient
- Defined in src/resources/artifacts.ts:68

Methods

createUpload

createUpload(
params: CreateArtifactUploadParams,
opts?: RequestOptions,
): Promise<ArtifactUploadGrant>
Mint an artifact ingest session for delivering a content-addressed bundle to one serving device. The returned grant carries the one-time sessionToken the caller streams the bytes with (no later read returns it).
Parameters
- params: CreateArtifactUploadParams
- Optionalopts: RequestOptions
Returns Promise<ArtifactUploadGrant>
- Defined in src/resources/artifacts.ts:75

get

get(
params: { applicationId: string; digest: string },
opts?: RequestOptions,
): Promise<ArtifactRecord>
Read an ArtifactRecord by digest (presence / idempotency probe). digest is URL-encoded into the path (sha256: contains a :).
Parameters
- params: { applicationId: string; digest: string }
- Optionalopts: RequestOptions
Returns Promise<ArtifactRecord>
Throws
NotFoundError when no artifact with this digest is registered.
- Defined in src/resources/artifacts.ts:134

getUpload

getUpload(
params: { applicationId: string; uploadId: string },
opts?: RequestOptions,
): Promise<StorageUploadSession>
Poll an artifact ingest session (the delivery waiter's poll target). The artifact session is an IngestSessionRecord, so it is read through the shared storage-session route; the session token is never returned here.
Parameters
- params: { applicationId: string; uploadId: string }
- Optionalopts: RequestOptions
Returns Promise<StorageUploadSession>
Throws
NotFoundError if the upload session does not exist.
- Defined in src/resources/artifacts.ts:99

register

register(
    params: {
        applicationId: string;
        digest: string;
        kind: ArtifactKind;
        size: number;
    },
    opts?: RequestOptions,
): Promise<RegisterArtifactResult>
Register (put-if-absent) the ArtifactRecord for a delivered digest. Idempotent — the first writer persists {digest, kind, size, source:'ingest', refCount:0}; refCount is driven up later at release cut.
Parameters
- params: { applicationId: string; digest: string; kind: ArtifactKind; size: number }
- Optionalopts: RequestOptions
Returns Promise<RegisterArtifactResult>
- Defined in src/resources/artifacts.ts:115