Snapshot

Properties:

• id string
• name string
• class ArtifactClass
• kind SnapshotKind
• availableIn string[]
• status string
• error? string | null

Constructors

Constructor

new Snapshot(snapshot: api.SnapshotRow): Snapshot;

Parameters:

• snapshot api.SnapshotRow

Returns:

• Snapshot

SnapshotsService

Constructors

Constructor

new SnapshotsService(http: AxiosInstance): SnapshotsService;

Parameters:

• http AxiosInstance

Returns:

• SnapshotsService

Methods

delete()

delete(snapshotId: string): Promise<void>;

Parameters:

• snapshotId string

Returns:

• Promise<void>

get()

get(
   snapshotId: string,
   options: { wait?: 'ready'; timeout?: number } = {}): Promise<Snapshot>;

Parameters:

• snapshotId string
• options { wait?: 'ready'; timeout?: number } = {}

Returns:

• Promise<Snapshot>

iter()

iter(
   options: { cursor?: string; limit?: number; name?: string } = {}): AsyncIterable<Snapshot>;

Parameters:

• options { cursor?: string; limit?: number; name?: string } = {}

Returns:

• AsyncIterable<Snapshot>

list()

list(
   options: { cursor?: string; limit?: number; name?: string } = {}): Promise<ListResult<Snapshot>>;

Parameters:

• options { cursor?: string; limit?: number; name?: string } = {}

Returns:

• Promise<ListResult<Snapshot>>