com.databricks.sdk.service.compute

Interface CommandExecutionService

@Generated
public interface CommandExecutionService

This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters. This API only supports (classic) all-purpose clusters. Serverless compute is not supported.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
void	cancel(CancelCommand cancelCommand) Cancels a currently running command within an execution context.
CommandStatusResponse	commandStatus(CommandStatusRequest commandStatusRequest) Gets the status of and, if available, the results from a currently executing command.
ContextStatusResponse	contextStatus(ContextStatusRequest contextStatusRequest) Gets the status for an execution context.
Created	create(CreateContext createContext) Creates an execution context for running cluster commands.
void	destroy(DestroyContext destroyContext) Deletes an execution context.
Created	execute(Command command) Runs a cluster command in the given execution context, using the provided language.

Method Detail

cancel

void cancel(CancelCommand cancelCommand)

Cancels a currently running command within an execution context.

The command ID is obtained from a prior successful call to __execute__.

commandStatus

CommandStatusResponse commandStatus(CommandStatusRequest commandStatusRequest)

Gets the status of and, if available, the results from a currently executing command.

The command ID is obtained from a prior successful call to __execute__.

contextStatus

ContextStatusResponse contextStatus(ContextStatusRequest contextStatusRequest)

Gets the status for an execution context.

create

Created create(CreateContext createContext)

Creates an execution context for running cluster commands.

If successful, this method returns the ID of the new execution context.

destroy

void destroy(DestroyContext destroyContext)

Deletes an execution context.

execute

Created execute(Command command)

Runs a cluster command in the given execution context, using the provided language.

If successful, it returns an ID for tracking the status of the command's execution.