Class DiskSnapshots

Hierarchy

APIResource
- DiskSnapshots

Index

Constructors

Properties

Methods

update list delete queryStatus awaitCompleted

Constructors

constructor

new DiskSnapshots(client: Runloop): DiskSnapshots
Parameters
- client: Runloop
Returns DiskSnapshots
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

update

update(
    id: string,
    body?: DiskSnapshotUpdateParams,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxSnapshotView>
Updates disk snapshot metadata via update vs patch. The entire metadata will be replaced.
Parameters
- id: string
- Optionalbody: DiskSnapshotUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxSnapshotView>
- Defined in src/resources/devboxes/disk-snapshots.ts:16
update(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<DevboxSnapshotView>
Updates disk snapshot metadata via update vs patch. The entire metadata will be replaced.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxSnapshotView>
- Defined in src/resources/devboxes/disk-snapshots.ts:21

list

list(
    query?: DiskSnapshotListParams,
    options?: RequestOptions<unknown>,
): PagePromise<
    DevboxSnapshotViewsDiskSnapshotsCursorIDPage,
    DevboxSnapshotView,
>
List all snapshots of a Devbox while optionally filtering by Devbox ID, source Blueprint ID, and metadata.
Parameters
- Optionalquery: DiskSnapshotListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<DevboxSnapshotViewsDiskSnapshotsCursorIDPage, DevboxSnapshotView>
- Defined in src/resources/devboxes/disk-snapshots.ts:37
list(
    options?: RequestOptions<unknown>,
): PagePromise<
    DevboxSnapshotViewsDiskSnapshotsCursorIDPage,
    DevboxSnapshotView,
>
List all snapshots of a Devbox while optionally filtering by Devbox ID, source Blueprint ID, and metadata.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<DevboxSnapshotViewsDiskSnapshotsCursorIDPage, DevboxSnapshotView>
- Defined in src/resources/devboxes/disk-snapshots.ts:41

delete

delete(id: string, options?: RequestOptions<unknown>): APIPromise<unknown>
Delete a previously taken disk snapshot of a Devbox.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<unknown>
- Defined in src/resources/devboxes/disk-snapshots.ts:61

queryStatus

queryStatus(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<DevboxSnapshotAsyncStatusView>
Get the current status of an asynchronous disk snapshot operation, including whether it is still in progress and any error messages if it failed.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxSnapshotAsyncStatusView>
- Defined in src/resources/devboxes/disk-snapshots.ts:69

awaitCompleted

awaitCompleted(
    id: string,
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<DevboxSnapshotAsyncStatusView>>;
    },
): Promise<DevboxSnapshotAsyncStatusView>
Wait for a disk snapshot to be completed. Polls the snapshot status until it reaches completed state or fails with an error.
Parameters
- id: string
  Snapshot ID
- Optionaloptions: RequestOptions<unknown> & {
  polling?: Partial<PollingOptions<DevboxSnapshotAsyncStatusView>>;
  }
  request options to specify retries, timeout, polling, etc.
Returns Promise<DevboxSnapshotAsyncStatusView>
- Defined in src/resources/devboxes/disk-snapshots.ts:80