Package alluxio.cli.fsadmin.command

Class DoctorCommand

java.lang.Object

alluxio.cli.fsadmin.command.AbstractFsAdminCommand

alluxio.cli.fsadmin.command.DoctorCommand

All Implemented Interfaces:

alluxio.cli.Command, java.io.Closeable, java.lang.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	Description
static java.lang.String	HELP_OPTION_NAME

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

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

Constructor Summary

Constructors

Constructor	Description
DoctorCommand(Context context, alluxio.conf.AlluxioConfiguration alluxioConf)

Method Summary

Modifier and Type	Method	Description
static java.lang.String	description()
java.lang.String	getCommandName()
java.lang.String	getDescription()
org.apache.commons.cli.Options	getOptions()
java.lang.String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl)
static java.lang.String	usage()
void	validateArgs(org.apache.commons.cli.CommandLine cl)

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 java.lang.String HELP_OPTION_NAME

See Also:

Constant Field Values

Constructor Detail

DoctorCommand

public DoctorCommand(Context context,
                     alluxio.conf.AlluxioConfiguration alluxioConf)

Parameters:

context - fsadmin command context

alluxioConf - Alluxio configuration

Method Detail

getCommandName

public java.lang.String getCommandName()

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws java.io.IOException

Throws:

java.io.IOException

getUsage

public java.lang.String getUsage()

usage

public static java.lang.String usage()

Returns:

the usage for the doctor command

getDescription

public java.lang.String getDescription()

description

public static java.lang.String description()

Returns:

the description for the doctor command

getOptions

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

validateArgs

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

Throws:

alluxio.exception.status.InvalidArgumentException