Class StorageClient

Per-application storage records plus the promote and upload LROs (see module doc).

Index

Constructors

Methods

cancelUpload createUpload getPromote getUpload listRecords listUploads promote

Constructors

constructor

new StorageClient(call: Caller, hooks?: OperationHooks): StorageClient
Parameters
- call: Caller
- hooks: OperationHooks = {}
Returns StorageClient
- Defined in src/resources/storage.ts:100

Methods

cancelUpload

cancelUpload(
params: { applicationId: string; uploadId: string },
opts?: RequestOptions,
): Promise<StorageUploadSession>
Cancel an in-flight upload session; returns the updated session.
Parameters
- params: { applicationId: string; uploadId: string }
- Optionalopts: RequestOptions
Returns Promise<StorageUploadSession>
Throws
NotFoundError if the upload session does not exist.
- Defined in src/resources/storage.ts:209

createUpload

createUpload(
params: CreateUploadParams,
opts?: RequestOptions,
): Promise<Operation<StorageUploadGrant>>
Mint an upload session for shipping local data into a storage volume. Operation.resource is the grant — including the one-time sessionToken, which no later read returns. The backend reads the idempotency key from the body, so opts.idempotencyKey is threaded there in addition to the Idempotency-Key header.
Parameters
- params: CreateUploadParams
- Optionalopts: RequestOptions
Returns Promise<Operation<StorageUploadGrant>>
- Defined in src/resources/storage.ts:162

getPromote

getPromote(promoteId: string, opts?: RequestOptions): Promise<PromoteRecord>
Fetch a promote record (the promote waiter's poll target).
Parameters
- promoteId: string
- Optionalopts: RequestOptions
Returns Promise<PromoteRecord>
Throws
NotFoundError if the promote does not exist.
- Defined in src/resources/storage.ts:145

getUpload

getUpload(
params: { applicationId: string; uploadId: string },
opts?: RequestOptions,
): Promise<StorageUploadSession>
Fetch an upload session (the upload waiter's poll target; 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/storage.ts:188

listRecords

listRecords(
params: { applicationId: string },
opts?: RequestOptions,
): Promise<StorageRecord[]>
Storage records for an application's declared storage entries.
Parameters
- params: { applicationId: string }
- Optionalopts: RequestOptions
Returns Promise<StorageRecord[]>
- Defined in src/resources/storage.ts:106

listUploads

listUploads(
params: { applicationId: string },
opts?: RequestOptions,
): Promise<StorageUploadSession[]>
List an application's upload sessions.
Parameters
- params: { applicationId: string }
- Optionalopts: RequestOptions
Returns Promise<StorageUploadSession[]>
- Defined in src/resources/storage.ts:197

promote

promote(
params: PromoteParams,
opts?: RequestOptions,
): Promise<Operation<PromoteRecord>>
Dispatch a promote (mobility-change) job. The backend reads the idempotency key from the body, so opts.idempotencyKey is threaded there in addition to the Idempotency-Key header.
Parameters
- params: PromoteParams
- Optionalopts: RequestOptions
Returns Promise<Operation<PromoteRecord>>
- Defined in src/resources/storage.ts:121