Class Executions

Hierarchy

APIResource
- Executions

Index

Constructors

constructor

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

Properties

`Protected`_client

_client: Runloop

Methods

retrieve

retrieve(
    devboxId: string,
    executionId: string,
    query?: ExecutionRetrieveParams,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxAsyncExecutionDetailView>
Get the latest status of a previously launched asynchronous execuction including stdout/error and the exit code if complete.
Parameters
- devboxId: string
- executionId: string
- Optionalquery: ExecutionRetrieveParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxAsyncExecutionDetailView>
- Defined in src/resources/devboxes/executions.ts:17
retrieve(
    devboxId: string,
    executionId: string,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxAsyncExecutionDetailView>
Get the latest status of a previously launched asynchronous execuction including stdout/error and the exit code if complete.
Parameters
- devboxId: string
- executionId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxAsyncExecutionDetailView>
- Defined in src/resources/devboxes/executions.ts:23

executeAsync

executeAsync(
    id: string,
    body: ExecutionExecuteAsyncParams,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxAsyncExecutionDetailView>
Execute the given command in the Devbox shell asynchronously and returns the execution that can be used to track the command's progress.
Parameters
- id: string
- body: ExecutionExecuteAsyncParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxAsyncExecutionDetailView>
- Defined in src/resources/devboxes/executions.ts:44

awaitCompleted

awaitCompleted(
    id: string,
    executionId: string,
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<DevboxAsyncExecutionDetailView>>;
    },
): Promise<DevboxAsyncExecutionDetailView>
Wait for an async execution to complete. Polls the execution status until it reaches completed state.
Parameters
- id: string
  Devbox ID
- executionId: string
  Execution ID
- Optionaloptions: RequestOptions<unknown> & {
  polling?: Partial<PollingOptions<DevboxAsyncExecutionDetailView>>;
  }
  request options to specify retries, timeout, polling, etc.
Returns Promise<DevboxAsyncExecutionDetailView>
- Defined in src/resources/devboxes/executions.ts:60

executeSync

executeSync(
    id: string,
    body: ExecutionExecuteSyncParams,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxExecutionDetailView>
Execute a bash command in the Devbox shell, await the command completion and return the output. Note: attach_stdin parameter is not supported for synchronous execution.
Parameters
- id: string
- body: ExecutionExecuteSyncParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxExecutionDetailView>
Deprecated
- Defined in src/resources/devboxes/executions.ts:105

kill

kill(
    devboxId: string,
    executionId: string,
    body?: ExecutionKillParams,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxAsyncExecutionDetailView>
Kill a previously launched asynchronous execution if it is still running by killing the launched process. Optionally kill the entire process group.
Parameters
- devboxId: string
- executionId: string
- Optionalbody: ExecutionKillParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxAsyncExecutionDetailView>
- Defined in src/resources/devboxes/executions.ts:121
kill(
    devboxId: string,
    executionId: string,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxAsyncExecutionDetailView>
Kill a previously launched asynchronous execution if it is still running by killing the launched process. Optionally kill the entire process group.
Parameters
- devboxId: string
- executionId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxAsyncExecutionDetailView>
- Defined in src/resources/devboxes/executions.ts:127

sendStdIn

sendStdIn(
    devboxId: string,
    executionId: string,
    body?: ExecutionSendStdInParams,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxSendStdInResult>
Send content to the Std In of a running execution.
Parameters
- devboxId: string
- executionId: string
- Optionalbody: ExecutionSendStdInParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxSendStdInResult>
- Defined in src/resources/devboxes/executions.ts:147
sendStdIn(
    devboxId: string,
    executionId: string,
    options?: RequestOptions<unknown>,
): APIPromise<DevboxSendStdInResult>
Send content to the Std In of a running execution.
Parameters
- devboxId: string
- executionId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<DevboxSendStdInResult>
- Defined in src/resources/devboxes/executions.ts:153

streamStderrUpdates

streamStderrUpdates(
    devboxId: string,
    executionId: string,
    query?: ExecutionStreamStderrUpdatesParams | undefined,
    options?: RequestOptions<unknown>,
): APIPromise<Stream<ExecutionUpdateChunk>>
Tails the stderr logs for the given execution with SSE streaming
Parameters
- devboxId: string
- executionId: string
- query: ExecutionStreamStderrUpdatesParams | undefined = {}
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Stream<ExecutionUpdateChunk>>
- Defined in src/resources/devboxes/executions.ts:176

streamStdoutUpdates

streamStdoutUpdates(
    devboxId: string,
    executionId: string,
    query?: ExecutionStreamStdoutUpdatesParams | undefined,
    options?: RequestOptions<unknown>,
): APIPromise<Stream<ExecutionUpdateChunk>>
Tails the stdout logs for the given execution with SSE streaming
Parameters
- devboxId: string
- executionId: string
- query: ExecutionStreamStdoutUpdatesParams | undefined = {}
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Stream<ExecutionUpdateChunk>>
- Defined in src/resources/devboxes/executions.ts:203

Class Executions

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Executions

Properties

Protected_client

Methods

retrieve

Parameters

Returns APIPromise<DevboxAsyncExecutionDetailView>

Parameters

Returns APIPromise<DevboxAsyncExecutionDetailView>

executeAsync

Parameters

Returns APIPromise<DevboxAsyncExecutionDetailView>

awaitCompleted

Parameters

Returns Promise<DevboxAsyncExecutionDetailView>

executeSync

Parameters

Returns APIPromise<DevboxExecutionDetailView>

Deprecated

kill

Parameters

Returns APIPromise<DevboxAsyncExecutionDetailView>

Parameters

Returns APIPromise<DevboxAsyncExecutionDetailView>

sendStdIn

Parameters

Returns APIPromise<DevboxSendStdInResult>

Parameters

Returns APIPromise<DevboxSendStdInResult>

streamStderrUpdates

Parameters

Returns APIPromise<Stream<ExecutionUpdateChunk>>

streamStdoutUpdates

Parameters

Returns APIPromise<Stream<ExecutionUpdateChunk>>

Settings

On This Page

`Protected`_client