alluxio.cli.fsadmin.pathconf

Class ListCommand

java.lang.Object

alluxio.cli.fsadmin.command.AbstractFsAdminCommand

alluxio.cli.fsadmin.pathconf.ListCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

public final class ListCommand
extends AbstractFsAdminCommand

Lists paths that have path level configuration.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ListCommand(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()
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 java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getOptions, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

ListCommand

public ListCommand(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

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

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

description

public static String description()

Returns:

command's description

getDescription

public String getDescription()

Returns:

the description information of the command