Package org.apache.drill.yarn.client

Enum CommandLineOptions.Command

java.lang.Object

java.lang.Enum<CommandLineOptions.Command>

org.apache.drill.yarn.client.CommandLineOptions.Command

All Implemented Interfaces:

Serializable, Comparable<CommandLineOptions.Command>

Enclosing class:

CommandLineOptions

public static enum CommandLineOptions.Command
extends Enum<CommandLineOptions.Command>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLEAN	Convenience command to remove the Drill-on-YARN archive(s) from DFS.
DESCRIBE	Convenience command to display the effective configuration settings to diagnose problems.
HELP
RESIZE
START	Primary command to upload the application archive and start the Drill cluster.
STATUS	Primary command to get the status of a running cluster.
STOP	Primary command to stop a running cluster.
TEST
UPLOAD	Convenience command to upload the application archive to test the DFS settings without launching the Drill cluster.

Method Summary

Modifier and Type	Method	Description
String	getCommand()
String	getDescription()
boolean	isHidden()
boolean	isMatch(String arg)
static CommandLineOptions.Command	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommandLineOptions.Command[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HELP

public static final CommandLineOptions.Command HELP

START

public static final CommandLineOptions.Command START

Primary command to upload the application archive and start the Drill cluster.

STOP

public static final CommandLineOptions.Command STOP

Primary command to stop a running cluster.

STATUS

public static final CommandLineOptions.Command STATUS

Primary command to get the status of a running cluster.

RESIZE

public static final CommandLineOptions.Command RESIZE

TEST

public static final CommandLineOptions.Command TEST

DESCRIBE

public static final CommandLineOptions.Command DESCRIBE

Convenience command to display the effective configuration settings to diagnose problems.

UPLOAD

public static final CommandLineOptions.Command UPLOAD

Convenience command to upload the application archive to test the DFS settings without launching the Drill cluster.

CLEAN

public static final CommandLineOptions.Command CLEAN

Convenience command to remove the Drill-on-YARN archive(s) from DFS. Note: doing this while a Drill cluster is running will cause subsequent Drillbit launches to fail.

Method Details

values

public static CommandLineOptions.Command[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommandLineOptions.Command valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isMatch

public boolean isMatch(String arg)

isHidden

public boolean isHidden()

getCommand

public String getCommand()

getDescription

public String getDescription()