org.apache.flink.client.cli

Interface CustomCommandLine<T>

All Known Implementing Classes:

AbstractCustomCommandLine, DefaultCLI, FlinkYarnSessionCli, LegacyCLI

public interface CustomCommandLine<T>

Custom command-line interface to load hooks for the command-line interface.

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.
ClusterDescriptor<T>	createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine) Create a ClusterDescriptor from the given configuration, configuration directory and the command line.
T	getClusterId(org.apache.commons.cli.CommandLine commandLine) Returns the cluster id if a cluster id was specified on the command line, otherwise it returns null.
ClusterSpecification	getClusterSpecification(org.apache.commons.cli.CommandLine commandLine) Returns the ClusterSpecification specified by the configuration and the 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.
default org.apache.commons.cli.CommandLine	parseCommandLineOptions(String[] args, boolean stopAtNonOptions)

Method Detail

isActive

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

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

getId

String getId()

Gets the unique identifier of this CustomCommandLine.

Returns:

A unique identifier

addRunOptions

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

Adds custom options to the existing run options.

Parameters:

baseOptions - The existing options.

addGeneralOptions

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

Adds custom options to the existing general options.

Parameters:

baseOptions - The existing options.

createClusterDescriptor

ClusterDescriptor<T> createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine)
                                      throws FlinkException

Create a ClusterDescriptor from the given configuration, configuration directory and the command line.

Parameters:

commandLine - containing command line options relevant for the ClusterDescriptor

Returns:

ClusterDescriptor

Throws:

FlinkException - if the ClusterDescriptor could not be created

getClusterId

@Nullable
T getClusterId(org.apache.commons.cli.CommandLine commandLine)

Returns the cluster id if a cluster id was specified on the command line, otherwise it returns null.

A cluster id identifies a running cluster, e.g. the Yarn application id for a Flink cluster running on Yarn.

Parameters:

commandLine - containing command line options relevant for the cluster id retrieval

Returns:

Cluster id identifying the cluster to deploy jobs to or null

getClusterSpecification

ClusterSpecification getClusterSpecification(org.apache.commons.cli.CommandLine commandLine)
                                      throws FlinkException

Returns the ClusterSpecification specified by the configuration and the command line options. This specification can be used to deploy a new Flink cluster.

Parameters:

commandLine - containing command line options relevant for the ClusterSpecification

Returns:

ClusterSpecification for a new Flink cluster

Throws:

FlinkException - if the ClusterSpecification could not be created

parseCommandLineOptions

default org.apache.commons.cli.CommandLine parseCommandLineOptions(String[] args,
                                                                   boolean stopAtNonOptions)
                                                            throws CliArgsException

Throws:

CliArgsException