org.apache.flink.client.cli

类 CliFrontend

java.lang.Object

org.apache.flink.client.cli.CliFrontend

public class CliFrontend
extends Object

Implementation of a simple command line frontend for executing programs.

构造器概要

构造器

构造器和说明
CliFrontend(org.apache.flink.configuration.Configuration configuration, ClusterClientServiceLoader clusterClientServiceLoader, List<CustomCommandLine> customCommandLines)
CliFrontend(org.apache.flink.configuration.Configuration configuration, List<CustomCommandLine> customCommandLines)

方法概要

限定符和类型	方法和说明
protected void	cancel(String[] args) Executes the CANCEL action.
protected void	executeProgram(org.apache.flink.configuration.Configuration configuration, PackagedProgram program)
CustomCommandLine	getActiveCustomCommandLine(org.apache.commons.cli.CommandLine commandLine) Gets the custom command-line for the arguments.
org.apache.commons.cli.CommandLine	getCommandLine(org.apache.commons.cli.Options commandOptions, String[] args, boolean stopAtNonOptions)
org.apache.flink.configuration.Configuration	getConfiguration() Getter which returns a copy of the associated configuration.
static String	getConfigurationDirectoryFromEnv()
org.apache.commons.cli.Options	getCustomCommandLineOptions()
protected void	info(String[] args) Executes the info action.
protected void	list(String[] args) Executes the list action.
static List<CustomCommandLine>	loadCustomCommandLines(org.apache.flink.configuration.Configuration configuration, String configurationDirectory)
static void	main(String[] args) Submits the job based on the arguments.
int	parseParameters(String[] args) Parses the command line arguments and starts the requested action.
protected void	run(String[] args) Executions the run action.
protected void	savepoint(String[] args) Executes the SAVEPOINT action.
protected void	stop(String[] args) Executes the STOP action.

从类继承的方法 java.lang.Object

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

构造器详细资料

CliFrontend

public CliFrontend(org.apache.flink.configuration.Configuration configuration,
                   List<CustomCommandLine> customCommandLines)

CliFrontend

public CliFrontend(org.apache.flink.configuration.Configuration configuration,
                   ClusterClientServiceLoader clusterClientServiceLoader,
                   List<CustomCommandLine> customCommandLines)

方法详细资料

getConfiguration

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

Getter which returns a copy of the associated configuration.

返回:

Copy of the associated configuration

getCustomCommandLineOptions

public org.apache.commons.cli.Options getCustomCommandLineOptions()

run

protected void run(String[] args)
            throws Exception

Executions the run action.

参数:

args - Command line arguments for the run action.

抛出:

Exception

info

protected void info(String[] args)
             throws Exception

Executes the info action.

参数:

args - Command line arguments for the info action.

抛出:

Exception

list

protected void list(String[] args)
             throws Exception

Executes the list action.

参数:

args - Command line arguments for the list action.

抛出:

Exception

stop

protected void stop(String[] args)
             throws Exception

Executes the STOP action.

参数:

args - Command line arguments for the stop action.

抛出:

Exception

cancel

protected void cancel(String[] args)
               throws Exception

Executes the CANCEL action.

参数:

args - Command line arguments for the cancel action.

抛出:

Exception

getCommandLine

public org.apache.commons.cli.CommandLine getCommandLine(org.apache.commons.cli.Options commandOptions,
                                                         String[] args,
                                                         boolean stopAtNonOptions)
                                                  throws CliArgsException

抛出:

CliArgsException

savepoint

protected void savepoint(String[] args)
                  throws Exception

Executes the SAVEPOINT action.

参数:

args - Command line arguments for the savepoint action.

抛出:

Exception

executeProgram

protected void executeProgram(org.apache.flink.configuration.Configuration configuration,
                              PackagedProgram program)
                       throws ProgramInvocationException

抛出:

ProgramInvocationException

parseParameters

public int parseParameters(String[] args)

Parses the command line arguments and starts the requested action.

参数:

args - command line arguments of the client.

返回:

The return code of the program

main

public static void main(String[] args)

Submits the job based on the arguments.

getConfigurationDirectoryFromEnv

public static String getConfigurationDirectoryFromEnv()

loadCustomCommandLines

public static List<CustomCommandLine> loadCustomCommandLines(org.apache.flink.configuration.Configuration configuration,
                                                             String configurationDirectory)

getActiveCustomCommandLine

public CustomCommandLine getActiveCustomCommandLine(org.apache.commons.cli.CommandLine commandLine)

Gets the custom command-line for the arguments.

参数:

commandLine - The input to the command-line.

返回:

custom command-line which is active (may only be one at a time)