org.apache.flink.client.cli

Class CliFrontendParser

java.lang.Object

org.apache.flink.client.cli.CliFrontendParser

public class CliFrontendParser
extends Object

A simple command line parser (based on Apache Commons CLI) that extracts command line options.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.cli.Option	ADDRESS_OPTION
static org.apache.commons.cli.Option	ARGS_OPTION
static org.apache.commons.cli.Option	DETACHED_OPTION
static org.apache.commons.cli.Option	PARALLELISM_OPTION
static org.apache.commons.cli.Option	PY_OPTION
static org.apache.commons.cli.Option	PYARCHIVE_OPTION
static org.apache.commons.cli.Option	PYEXEC_OPTION
static org.apache.commons.cli.Option	PYFILES_OPTION
static org.apache.commons.cli.Option	PYMODULE_OPTION
static org.apache.commons.cli.Option	PYREQUIREMENTS_OPTION
static org.apache.commons.cli.Option	SAVEPOINT_ALLOW_NON_RESTORED_OPTION
static org.apache.commons.cli.Option	SAVEPOINT_PATH_OPTION
static org.apache.commons.cli.Option	SHUTDOWN_IF_ATTACHED_OPTION
static org.apache.commons.cli.Option	STOP_AND_DRAIN
static org.apache.commons.cli.Option	STOP_WITH_SAVEPOINT_PATH
static org.apache.commons.cli.Option	YARN_DETACHED_OPTION Deprecated. use non-prefixed variant DETACHED_OPTION for both YARN and non-YARN deployments

Constructor Summary

Constructors

Constructor and Description
CliFrontendParser()

Method Summary

Modifier and Type	Method and Description
static SavepointRestoreSettings	createSavepointRestoreSettings(org.apache.commons.cli.CommandLine commandLine)
static org.apache.commons.cli.Options	getRunCommandOptions()
static org.apache.commons.cli.Options	mergeOptions(org.apache.commons.cli.Options optionsA, org.apache.commons.cli.Options optionsB) Merges the given Options into a new Options object.
static org.apache.commons.cli.CommandLine	parse(org.apache.commons.cli.Options options, String[] args, boolean stopAtNonOptions)
static void	printHelp(Collection<CustomCommandLine> customCommandLines) Prints the help for the client.
static void	printHelpForCancel(Collection<CustomCommandLine> customCommandLines)
static void	printHelpForInfo()
static void	printHelpForList(Collection<CustomCommandLine> customCommandLines)
static void	printHelpForRun(Collection<CustomCommandLine> customCommandLines)
static void	printHelpForSavepoint(Collection<CustomCommandLine> customCommandLines)
static void	printHelpForStop(Collection<CustomCommandLine> customCommandLines)

Methods inherited from class java.lang.Object

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

Field Detail

PARALLELISM_OPTION

public static final org.apache.commons.cli.Option PARALLELISM_OPTION

DETACHED_OPTION

public static final org.apache.commons.cli.Option DETACHED_OPTION

SHUTDOWN_IF_ATTACHED_OPTION

public static final org.apache.commons.cli.Option SHUTDOWN_IF_ATTACHED_OPTION

YARN_DETACHED_OPTION

@Deprecated
public static final org.apache.commons.cli.Option YARN_DETACHED_OPTION

Deprecated. use non-prefixed variant DETACHED_OPTION for both YARN and non-YARN deployments

ARGS_OPTION

public static final org.apache.commons.cli.Option ARGS_OPTION

ADDRESS_OPTION

public static final org.apache.commons.cli.Option ADDRESS_OPTION

SAVEPOINT_PATH_OPTION

public static final org.apache.commons.cli.Option SAVEPOINT_PATH_OPTION

SAVEPOINT_ALLOW_NON_RESTORED_OPTION

public static final org.apache.commons.cli.Option SAVEPOINT_ALLOW_NON_RESTORED_OPTION

STOP_WITH_SAVEPOINT_PATH

public static final org.apache.commons.cli.Option STOP_WITH_SAVEPOINT_PATH

STOP_AND_DRAIN

public static final org.apache.commons.cli.Option STOP_AND_DRAIN

PY_OPTION

public static final org.apache.commons.cli.Option PY_OPTION

PYFILES_OPTION

public static final org.apache.commons.cli.Option PYFILES_OPTION

PYMODULE_OPTION

public static final org.apache.commons.cli.Option PYMODULE_OPTION

PYREQUIREMENTS_OPTION

public static final org.apache.commons.cli.Option PYREQUIREMENTS_OPTION

PYARCHIVE_OPTION

public static final org.apache.commons.cli.Option PYARCHIVE_OPTION

PYEXEC_OPTION

public static final org.apache.commons.cli.Option PYEXEC_OPTION

Constructor Detail

CliFrontendParser

public CliFrontendParser()

Method Detail

getRunCommandOptions

public static org.apache.commons.cli.Options getRunCommandOptions()

printHelp

public static void printHelp(Collection<CustomCommandLine> customCommandLines)

Prints the help for the client.

printHelpForRun

public static void printHelpForRun(Collection<CustomCommandLine> customCommandLines)

printHelpForInfo

public static void printHelpForInfo()

printHelpForList

public static void printHelpForList(Collection<CustomCommandLine> customCommandLines)

printHelpForStop

public static void printHelpForStop(Collection<CustomCommandLine> customCommandLines)

printHelpForCancel

public static void printHelpForCancel(Collection<CustomCommandLine> customCommandLines)

printHelpForSavepoint

public static void printHelpForSavepoint(Collection<CustomCommandLine> customCommandLines)

createSavepointRestoreSettings

public static SavepointRestoreSettings createSavepointRestoreSettings(org.apache.commons.cli.CommandLine commandLine)

parse

public static org.apache.commons.cli.CommandLine parse(org.apache.commons.cli.Options options,
                                                       String[] args,
                                                       boolean stopAtNonOptions)
                                                throws CliArgsException

Throws:

CliArgsException

mergeOptions

public static org.apache.commons.cli.Options mergeOptions(@Nullable
                                                          org.apache.commons.cli.Options optionsA,
                                                          @Nullable
                                                          org.apache.commons.cli.Options optionsB)

Merges the given Options into a new Options object.

Parameters:

optionsA - options to merge, can be null if none

optionsB - options to merge, can be null if none

Returns: