org.apache.flink.client.cli

Class GenericCLI

java.lang.Object

org.apache.flink.client.cli.GenericCLI

All Implemented Interfaces:

CustomCommandLine

@Internal
public class GenericCLI
extends Object
implements CustomCommandLine

A generic implementation of the CustomCommandLine that only expects the execution.target parameter to be explicitly specified and simply forwards the rest of the options specified with -D to the corresponding PipelineExecutor for further parsing.

Constructor Summary

Constructors

Constructor and Description
GenericCLI(Configuration configuration, String configDir)

Method Summary

Modifier and Type	Method and Description
void	addGeneralOptions(org.apache.commons.cli.Options baseOptions) Adds custom options to the existing general options.
void	addRunOptions(org.apache.commons.cli.Options baseOptions) Adds custom options to the existing run options.
Configuration	applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine) Override configuration settings by specified command line 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.

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

Constructor Detail

GenericCLI

public GenericCLI(Configuration configuration,
                  String configDir)

Method Detail

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.

Specified by:

isActive in interface CustomCommandLine

Parameters:

commandLine - The command-line options

Returns:

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

getId

public String getId()

Description copied from interface: CustomCommandLine

Gets the unique identifier of this CustomCommandLine.

Specified by:

getId in interface CustomCommandLine

Returns:

A unique identifier

addRunOptions

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

Description copied from interface: CustomCommandLine

Adds custom options to the existing run options.

Specified by:

addRunOptions in interface CustomCommandLine

Parameters:

baseOptions - The existing options.

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

Parameters:

baseOptions - The existing options.

applyCommandLineOptionsToConfiguration

public Configuration applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine)

Description copied from interface: CustomCommandLine

Override configuration settings by specified command line options.

Specified by:

applyCommandLineOptionsToConfiguration in interface CustomCommandLine

Parameters:

commandLine - containing the overriding values

Returns:

the effective configuration with the overridden configuration settings