Class SandboxClient

Index

Constructors

Methods

createDirectory createSandbox deletePath deleteSandbox executeCommandSync getMetadata getSandbox listCommands listDirectoryContents listDirectoryContentsIter listSandboxes listSandboxesIter renamePath startSandbox stopSandbox updateSandbox

Constructors

constructor

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

Methods

createDirectory

createDirectory(
req: CreateDirectoryRequest,
options?: CallOptions,
): Promise<CreateDirectoryResponse>
Creates a directory in a sandbox, including missing parents by default.
Parameters
- req: CreateDirectoryRequest
- Optionaloptions: CallOptions
Returns Promise<CreateDirectoryResponse>
- Defined in client.ts:361

createSandbox

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

deletePath

deletePath(
req: DeletePathRequest,
options?: CallOptions,
): Promise<DeletePathResponse>
Deletes a file, symlink, or empty directory, with an option for recursive deletion. Succeeds if the path is already absent.
Parameters
- req: DeletePathRequest
- Optionaloptions: CallOptions
Returns Promise<DeletePathResponse>
- Defined in client.ts:394

deleteSandbox

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

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:553

getMetadata

getMetadata(
req: GetMetadataRequest,
options?: CallOptions,
): Promise<GetMetadataResponse>
Returns metadata for a path without following its final symlink.
Parameters
- req: GetMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<GetMetadataResponse>
- Defined in client.ts:424

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:163

listCommands

listCommands(
req: ListCommandsRequest,
options?: CallOptions,
): Promise<ListCommandsResponse>
Lists the tracked command executions (running and completed) in a sandbox.
Parameters
- req: ListCommandsRequest
- Optionaloptions: CallOptions
Returns Promise<ListCommandsResponse>
- Defined in client.ts:583

listDirectoryContents

listDirectoryContents(
req: ListDirectoryContentsRequest,
options?: CallOptions,
): Promise<ListDirectoryContentsResponse>
Lists a directory's immediate children in UTF-8 name order. Later pages may reflect concurrent changes.
Parameters
- req: ListDirectoryContentsRequest
- Optionaloptions: CallOptions
Returns Promise<ListDirectoryContentsResponse>
- Defined in client.ts:459

listDirectoryContentsIter

listDirectoryContentsIter(
req: ListDirectoryContentsRequest,
options?: CallOptions,
): AsyncGenerator<SandboxFileInfo>
Parameters
- req: ListDirectoryContentsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SandboxFileInfo>
- Defined in client.ts:502

listSandboxes

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

listSandboxesIter

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

renamePath

renamePath(
req: RenamePathRequest,
options?: CallOptions,
): Promise<RenamePathResponse>
Renames a path within a sandbox. The destination must be absent and on the same filesystem.
Parameters
- req: RenamePathRequest
- Optionaloptions: CallOptions
Returns Promise<RenamePathResponse>
- Defined in client.ts:520

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:251

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:284

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:319