alluxio.cli.job.command

Class StatCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.job.command.StatCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class StatCommand
extends AbstractFileSystemCommand

Displays the status of the job.

Field Summary

Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
StatCommand(FileSystemContext fsContext) Creates the job stat command.

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
org.apache.commons.cli.Options	getOptions()
String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

processHeader, runPlainPath, runWildCardCmd

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

StatCommand

public StatCommand(FileSystemContext fsContext)

Creates the job stat command.

Parameters:

fsContext - the Alluxio filesystem client

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

getOptions

public org.apache.commons.cli.Options getOptions()

Returns:

the supported Options of the command

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               IOException

Description copied from interface: Command

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

getUsage

public String getUsage()

Returns:

the usage information of the command

getDescription

public String getDescription()

Returns:

the description information of the command

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws InvalidArgumentException

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid