Package org.apache.flink.client.cli

Class DefaultCLI

java.lang.Object

org.apache.flink.client.cli.AbstractCustomCommandLine

org.apache.flink.client.cli.DefaultCLI

All Implemented Interfaces:

CustomCommandLine

public class DefaultCLI
extends AbstractCustomCommandLine

The default CLI which is used for interaction with standalone clusters.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class org.apache.flink.client.cli.AbstractCustomCommandLine

zookeeperNamespaceOption

Constructor Summary

Constructors

Constructor	Description
DefaultCLI()

Method Summary

Modifier and Type	Method	Description
void	addGeneralOptions(org.apache.commons.cli.Options baseOptions)	Adds custom options to the existing general options.
String	getId()	Gets the unique identifier of this CustomCommandLine.
boolean	isActive(org.apache.commons.cli.CommandLine commandLine)	Signals whether the custom command-line wants to execute or not.
org.apache.flink.configuration.Configuration	toConfiguration(org.apache.commons.cli.CommandLine commandLine)	Materializes the command line arguments in the given CommandLine to a Configuration and returns it.

Methods inherited from class org.apache.flink.client.cli.AbstractCustomCommandLine

addRunOptions, handleCliArgsException, handleError, printUsage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.client.cli.CustomCommandLine

parseCommandLineOptions

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

DefaultCLI

public DefaultCLI()

Method Details

isActive

public boolean isActive(org.apache.commons.cli.CommandLine commandLine)

Description copied from interface: CustomCommandLine

Signals whether the custom command-line wants to execute or not.

Parameters:

commandLine - The command-line options

Returns:

True if the command-line wants to run, False otherwise

toConfiguration

public org.apache.flink.configuration.Configuration toConfiguration(org.apache.commons.cli.CommandLine commandLine)
                                                             throws org.apache.flink.util.FlinkException

Description copied from interface: CustomCommandLine

Materializes the command line arguments in the given CommandLine to a Configuration and returns it.

Specified by:

toConfiguration in interface CustomCommandLine

Overrides:

toConfiguration in class AbstractCustomCommandLine

Throws:

org.apache.flink.util.FlinkException

getId

public String getId()

Description copied from interface: CustomCommandLine

Gets the unique identifier of this CustomCommandLine.

Returns:

A unique identifier

addGeneralOptions

public void addGeneralOptions(org.apache.commons.cli.Options baseOptions)

Description copied from interface: CustomCommandLine

Adds custom options to the existing general options.

Specified by:

addGeneralOptions in interface CustomCommandLine

Overrides:

addGeneralOptions in class AbstractCustomCommandLine

Parameters:

baseOptions - The existing options.