com.databricks.sdk.service.compute

Class CommandExecutionAPI

java.lang.Object

com.databricks.sdk.service.compute.CommandExecutionAPI

@Generated
public class CommandExecutionAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
CommandExecutionAPI(ApiClient apiClient) Regular-use constructor
CommandExecutionAPI(CommandExecutionService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Wait<CommandStatusResponse,Void>	cancel(CancelCommand request) Cancels a currently running command within an execution context.
CommandStatusResponse	commandStatus(CommandStatusRequest request) Gets the status of and, if available, the results from a currently executing command.
CommandStatusResponse	commandStatus(String clusterId, String contextId, String commandId)
ContextStatusResponse	contextStatus(ContextStatusRequest request) Gets the status for an execution context.
ContextStatusResponse	contextStatus(String clusterId, String contextId)
Wait<ContextStatusResponse,Created>	create(CreateContext request) Creates an execution context for running cluster commands.
void	destroy(DestroyContext request) Deletes an execution context.
Wait<CommandStatusResponse,Created>	execute(Command request) Runs a cluster command in the given execution context, using the provided language.
CommandExecutionService	impl()
CommandStatusResponse	waitCommandStatusCommandExecutionCancelled(String clusterId, String commandId, String contextId)
CommandStatusResponse	waitCommandStatusCommandExecutionCancelled(String clusterId, String commandId, String contextId, Duration timeout, Consumer<CommandStatusResponse> callback)
CommandStatusResponse	waitCommandStatusCommandExecutionFinishedOrError(String clusterId, String commandId, String contextId)
CommandStatusResponse	waitCommandStatusCommandExecutionFinishedOrError(String clusterId, String commandId, String contextId, Duration timeout, Consumer<CommandStatusResponse> callback)
ContextStatusResponse	waitContextStatusCommandExecutionRunning(String clusterId, String contextId)
ContextStatusResponse	waitContextStatusCommandExecutionRunning(String clusterId, String contextId, Duration timeout, Consumer<ContextStatusResponse> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandExecutionAPI

public CommandExecutionAPI(ApiClient apiClient)

Regular-use constructor

CommandExecutionAPI

public CommandExecutionAPI(CommandExecutionService mock)

Constructor for mocks

Method Detail

waitCommandStatusCommandExecutionCancelled

public CommandStatusResponse waitCommandStatusCommandExecutionCancelled(String clusterId,
                                                                        String commandId,
                                                                        String contextId)
                                                                 throws TimeoutException

Throws:

TimeoutException

waitCommandStatusCommandExecutionCancelled

public CommandStatusResponse waitCommandStatusCommandExecutionCancelled(String clusterId,
                                                                        String commandId,
                                                                        String contextId,
                                                                        Duration timeout,
                                                                        Consumer<CommandStatusResponse> callback)
                                                                 throws TimeoutException

Throws:

TimeoutException

waitContextStatusCommandExecutionRunning

public ContextStatusResponse waitContextStatusCommandExecutionRunning(String clusterId,
                                                                      String contextId)
                                                               throws TimeoutException

Throws:

TimeoutException

waitContextStatusCommandExecutionRunning

public ContextStatusResponse waitContextStatusCommandExecutionRunning(String clusterId,
                                                                      String contextId,
                                                                      Duration timeout,
                                                                      Consumer<ContextStatusResponse> callback)
                                                               throws TimeoutException

Throws:

TimeoutException

waitCommandStatusCommandExecutionFinishedOrError

public CommandStatusResponse waitCommandStatusCommandExecutionFinishedOrError(String clusterId,
                                                                              String commandId,
                                                                              String contextId)
                                                                       throws TimeoutException

Throws:

TimeoutException

waitCommandStatusCommandExecutionFinishedOrError

public CommandStatusResponse waitCommandStatusCommandExecutionFinishedOrError(String clusterId,
                                                                              String commandId,
                                                                              String contextId,
                                                                              Duration timeout,
                                                                              Consumer<CommandStatusResponse> callback)
                                                                       throws TimeoutException

Throws:

TimeoutException

cancel

public Wait<CommandStatusResponse,Void> cancel(CancelCommand request)

Cancels a currently running command within an execution context.

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

commandStatus

public CommandStatusResponse commandStatus(String clusterId,
                                           String contextId,
                                           String commandId)

commandStatus

public CommandStatusResponse commandStatus(CommandStatusRequest request)

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

public ContextStatusResponse contextStatus(String clusterId,
                                           String contextId)

contextStatus

public ContextStatusResponse contextStatus(ContextStatusRequest request)

Gets the status for an execution context.

create

public Wait<ContextStatusResponse,Created> create(CreateContext request)

Creates an execution context for running cluster commands.

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

destroy

public void destroy(DestroyContext request)

Deletes an execution context.

execute

public Wait<CommandStatusResponse,Created> execute(Command request)

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.

impl

public CommandExecutionService impl()