Class SandboxClient

Index

Constructors

Methods

createSandbox deleteSandbox executeCommandSync getSandbox listSandboxes listSandboxesIter startSandbox stopSandbox updateSandbox

Constructors

constructor

new SandboxClient(options: ClientOptions): SandboxClient
Parameters
- options: ClientOptions
Returns SandboxClient
- Defined in client.ts:60

Methods

createSandbox

createSandbox(
req: CreateSandboxRequest,
options?: CallOptions,
): Promise<Sandbox>
Creates a new Sandbox.
Parameters
- req: CreateSandboxRequest
- Optionaloptions: CallOptions
Returns Promise<Sandbox>
- Defined in client.ts:76

deleteSandbox

deleteSandbox(req: DeleteSandboxRequest, options?: CallOptions): Promise<void>
Deletes a Sandbox.
Parameters
- req: DeleteSandboxRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:118

executeCommandSync

executeCommandSync(
req: ExecuteCommandSyncRequest,
options?: CallOptions,
): Promise<ExecuteCommandSyncResponse>
Runs a command in the sandbox and blocks until it exits, returning the captured stdout, stderr and exit code in a single response.
Parameters
- req: ExecuteCommandSyncRequest
- Optionaloptions: CallOptions
Returns Promise<ExecuteCommandSyncResponse>
- Defined in client.ts:342

getSandbox

getSandbox(req: GetSandboxRequest, options?: CallOptions): Promise<Sandbox>
Retrieves a Sandbox by name.
Parameters
- req: GetSandboxRequest
- Optionaloptions: CallOptions
Returns Promise<Sandbox>
- Defined in client.ts:141

listSandboxes

listSandboxes(
req: ListSandboxesRequest,
options?: CallOptions,
): Promise<ListSandboxesResponse>
Lists all Sandboxes.
Parameters
- req: ListSandboxesRequest
- Optionaloptions: CallOptions
Returns Promise<ListSandboxesResponse>
- Defined in client.ts:170

listSandboxesIter

listSandboxesIter(
req: ListSandboxesRequest,
options?: CallOptions,
): AsyncGenerator<Sandbox>
Parameters
- req: ListSandboxesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Sandbox>
- Defined in client.ts:207

startSandbox

startSandbox(req: StartSandboxRequest, options?: CallOptions): Promise<Sandbox>
Starts a previously stopped Sandbox under the same sandbox name. Returns NOT_FOUND if there is no stopped sandbox to start for the given name.
Parameters
- req: StartSandboxRequest
- Optionaloptions: CallOptions
Returns Promise<Sandbox>
- Defined in client.ts:229

stopSandbox

stopSandbox(req: StopSandboxRequest, options?: CallOptions): Promise<Sandbox>
Stops a running Sandbox, preserving it so it can later be restarted with a Start request.
Parameters
- req: StopSandboxRequest
- Optionaloptions: CallOptions
Returns Promise<Sandbox>
- Defined in client.ts:262

updateSandbox

updateSandbox(
req: UpdateSandboxRequest,
options?: CallOptions,
): Promise<Sandbox>
Updates mutable fields on an existing Sandbox. Allowlisted update_mask paths today: display_name, spec.compute.inactivity_timeout. Returns INVALID_PARAMETER_VALUE for empty masks or unknown paths; NOT_FOUND if the sandbox does not exist.
Parameters
- req: UpdateSandboxRequest
- Optionaloptions: CallOptions
Returns Promise<Sandbox>
- Defined in client.ts:297