org.apache.flink.client.cli

Class DefaultCLI

java.lang.Object

org.apache.flink.client.cli.AbstractCustomCommandLine<StandaloneClusterId>

org.apache.flink.client.cli.DefaultCLI

All Implemented Interfaces:

CustomCommandLine<StandaloneClusterId>

public class DefaultCLI
extends AbstractCustomCommandLine<StandaloneClusterId>

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

Field Summary

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

addressOption, configuration, zookeeperNamespaceOption

Constructor Summary

Constructors

Constructor and Description
DefaultCLI(org.apache.flink.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
void	addGeneralOptions(org.apache.commons.cli.Options baseOptions) Adds custom options to the existing general options.
StandaloneClusterDescriptor	createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine) Create a ClusterDescriptor from the given configuration, configuration directory and the command line.
StandaloneClusterId	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.

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

addRunOptions, applyCommandLineOptionsToConfiguration, getConfiguration

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

DefaultCLI

public DefaultCLI(org.apache.flink.configuration.Configuration configuration)

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.

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.

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<StandaloneClusterId>

Overrides:

addGeneralOptions in class AbstractCustomCommandLine<StandaloneClusterId>

Parameters:

baseOptions - The existing options.

createClusterDescriptor

public StandaloneClusterDescriptor createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine)
                                                    throws org.apache.flink.util.FlinkException

Description copied from interface: CustomCommandLine

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:

org.apache.flink.util.FlinkException - if the ClusterDescriptor could not be created

getClusterId

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

Description copied from interface: CustomCommandLine

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

public ClusterSpecification getClusterSpecification(org.apache.commons.cli.CommandLine commandLine)

Description copied from interface: CustomCommandLine

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