alluxio.cli.fsadmin.command

Class DoctorCommand

java.lang.Object

alluxio.cli.fsadmin.command.AbstractFsAdminCommand

alluxio.cli.fsadmin.command.DoctorCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@PublicApi
public final class DoctorCommand
extends AbstractFsAdminCommand

Shows errors or warnings that users should pay attention to.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HELP_OPTION_NAME

Fields inherited from class alluxio.cli.fsadmin.command.AbstractFsAdminCommand

mBlockClient, mFsClient, mJobMasterClient, mJobMasterJournalMasterClient, mMasterJournalMasterClient, mMetaClient, mMetricsClient, mPrintStream

Constructor Summary

Constructors

Constructor and Description
DoctorCommand(Context context, AlluxioConfiguration alluxioConf)

Method Summary

Modifier and Type	Method and Description
static String	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.
static String	usage()
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

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

Field Detail

HELP_OPTION_NAME

public static final String HELP_OPTION_NAME

See Also:

Constant Field Values

Constructor Detail

DoctorCommand

public DoctorCommand(Context context,
                     AlluxioConfiguration alluxioConf)

Parameters:

context - fsadmin command context

alluxioConf - Alluxio configuration

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws 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:

IOException

getUsage

public String getUsage()

Returns:

the usage information of the command

usage

public static String usage()

Returns:

the usage for the doctor command

getDescription

public String getDescription()

Returns:

the description information of the command

description

public static String description()

Returns:

the description for the doctor command

getOptions

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

Returns:

the supported Options 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