com.cloudera.api.v1

Interface CommandsResource

All Known Subinterfaces:

CommandsResourceV11

public interface CommandsResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	abortCommand(long commandId) Abort a running command.
ApiCommand	readCommand(long commandId) Retrieve detailed information on an asynchronous command.

Method Detail

readCommand

@Path(value="/{commandId}")
ApiCommand readCommand(long commandId)

Retrieve detailed information on an asynchronous command.

Cloudera Manager keeps the results and statuses of asynchronous commands, which have non-negative command IDs. On the other hand, synchronous commands complete immediately, and their results are passed back in the return object of the command execution API call. Outside of that return object, there is no way to check the result of a synchronous command.

Parameters:

commandId - The command id.

Returns:

Detailed command information.

abortCommand

@Path(value="/{commandId}/abort")
ApiCommand abortCommand(long commandId)

Abort a running command.

Parameters:

commandId - The command id.

Returns:

Detailed command information.