Databricks SDK for JavaScript
    Preparing search index...

    Interface ExecuteCommandSyncRequest

    Request to run a command in the given sandbox and wait for it to finish.

    interface ExecuteCommandSyncRequest {
        args?: string[];
        cmd?: string;
        envs?: Record<string, string>;
        executionTimeout?: Duration;
        name?: string;
    }
    Index

    Properties

    args? cmd? envs? executionTimeout? name?

    Properties

    args?: string[]

    Arguments passed to cmd.

    cmd?: string

    Executable or command to run (e.g. /bin/echo, python3).

    envs?: Record<string, string>

    Extra environment variables for the command's process, merged over the sandbox's default environment.

    executionTimeout?: Duration

    Maximum time to wait for the command to finish. When it elapses the command is terminated and the response carries status TIMED_OUT. The server applies a default when unset and clamps to an upper bound; negative or otherwise invalid durations are rejected with INVALID_ARGUMENT.

    name?: string

    Resource name of the sandbox to run the command in, in the form sandboxes/{sandbox_id}. Bound from the URL path.

    Settings

    Member Visibility

    On This Page

    Properties