org.apache.flink.client.cli

Interface CustomCommandLine<ClusterType extends ClusterClient>

All Known Implementing Classes:

DefaultCLI

public interface CustomCommandLine<ClusterType extends ClusterClient>

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

Method Summary

Methods

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.
ClusterType	createCluster(String applicationName, org.apache.commons.cli.CommandLine commandLine, Configuration config, List<URL> userJarFiles) Creates the client for the cluster
String	getId() Gets the unique identifier of this CustomCommandLine
boolean	isActive(org.apache.commons.cli.CommandLine commandLine, Configuration configuration) Signals whether the custom command-line wants to execute or not
ClusterType	retrieveCluster(org.apache.commons.cli.CommandLine commandLine, Configuration config) Retrieves a client for a running cluster

Method Detail

isActive

boolean isActive(org.apache.commons.cli.CommandLine commandLine,
               Configuration configuration)

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

Parameters:

commandLine - The command-line options

configuration - The Flink configuration

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.

retrieveCluster

ClusterType retrieveCluster(org.apache.commons.cli.CommandLine commandLine,
                          Configuration config)
                                                  throws UnsupportedOperationException

Retrieves a client for a running cluster

Parameters:

commandLine - The command-line parameters from the CliFrontend

config - The Flink config

Returns:

Client if a cluster could be retrieved

Throws:

UnsupportedOperationException - if the operation is not supported

createCluster

ClusterType createCluster(String applicationName,
                        org.apache.commons.cli.CommandLine commandLine,
                        Configuration config,
                        List<URL> userJarFiles)
                                                throws UnsupportedOperationException

Creates the client for the cluster

Parameters:

applicationName - The application name to use

commandLine - The command-line options parsed by the CliFrontend

config - The Flink config to use

userJarFiles - User jar files to include in the classpath of the cluster.

Returns:

The client to communicate with the cluster which the CustomCommandLine brought up.

Throws:

UnsupportedOperationException - if the operation is not supported