alluxio.cli.fsadmin.pathconf

Class AddCommand

java.lang.Object

alluxio.cli.fsadmin.command.AbstractFsAdminCommand

alluxio.cli.fsadmin.pathconf.AddCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

public final class AddCommand
extends AbstractFsAdminCommand

Adds path level configurations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_OPTION_NAME

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

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

Constructor Summary

Constructors

Constructor and Description
AddCommand(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()
static String	nonClientScopePropertyException(PropertyKey key)
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, getSubCommands, hasSubCommand, parseAndValidateArgs

Field Detail

PROPERTY_OPTION_NAME

public static final String PROPERTY_OPTION_NAME

See Also:

Constant Field Values

Constructor Detail

AddCommand

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

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

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

description

public static String description()

Returns:

command's description

nonClientScopePropertyException

public static String nonClientScopePropertyException(PropertyKey key)

Parameters:

key - the property key

Returns:

the exception message for a non-client scope property key

getDescription

public String getDescription()

Returns:

the description information of the command