Class CommandExecutionClient

Index

Constructors

Methods

cancel create destroy execute getCommandStatus getContextStatus

Constructors

constructor

new CommandExecutionClient(options: ClientOptions): CommandExecutionClient
Parameters
- options: ClientOptions
Returns CommandExecutionClient
- Defined in client.ts:67

Methods

cancel

cancel(req: CancelCommandRequest, options?: CallOptions): Promise<CancelWaiter>
Cancels a currently running command within an execution context.

The command ID is obtained from a prior successful call to execute.
Parameters
- req: CancelCommandRequest
- Optionaloptions: CallOptions
Returns Promise<CancelWaiter>
- Defined in client.ts:121

create

create(req: CreateContextRequest, options?: CallOptions): Promise<CreateWaiter>
Creates an execution context for running cluster commands.

If successful, this method returns the ID of the new execution context.
Parameters
- req: CreateContextRequest
- Optionaloptions: CallOptions
Returns Promise<CreateWaiter>
- Defined in client.ts:183

destroy

destroy(
req: DestroyContextRequest,
options?: CallOptions,
): Promise<DestroyResponse>
Deletes an execution context.
Parameters
- req: DestroyContextRequest
- Optionaloptions: CallOptions
Returns Promise<DestroyResponse>
- Defined in client.ts:200

execute

execute(
req: ExecuteCommandRequest,
options?: CallOptions,
): Promise<ExecuteWaiter>
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.
Parameters
- req: ExecuteCommandRequest
- Optionaloptions: CallOptions
Returns Promise<ExecuteWaiter>
- Defined in client.ts:268

getCommandStatus

getCommandStatus(
req: GetCommandStatusRequest,
options?: CallOptions,
): Promise<GetCommandStatusResponse>
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.
Parameters
- req: GetCommandStatusRequest
- Optionaloptions: CallOptions
Returns Promise<GetCommandStatusResponse>
- Defined in client.ts:294

getContextStatus

getContextStatus(
req: GetContextStatusRequest,
options?: CallOptions,
): Promise<GetContextStatusResponse>
Gets the status for an execution context.
Parameters
- req: GetContextStatusRequest
- Optionaloptions: CallOptions
Returns Promise<GetContextStatusResponse>
- Defined in client.ts:335