org.apache.flink.client.cli

接口 CustomCommandLine

所有已知实现类:

AbstractCustomCommandLine, DefaultCLI, ExecutorCLI

public interface CustomCommandLine

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

方法概要

限定符和类型	方法和说明
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.
org.apache.flink.configuration.Configuration	applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine) Override configuration settings by specified 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)

方法详细资料

isActive

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

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

参数:

commandLine - The command-line options

返回:

True if the command-line wants to run, False otherwise

getId

String getId()

Gets the unique identifier of this CustomCommandLine.

返回:

A unique identifier

addRunOptions

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

Adds custom options to the existing run options.

参数:

baseOptions - The existing options.

addGeneralOptions

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

Adds custom options to the existing general options.

参数:

baseOptions - The existing options.

applyCommandLineOptionsToConfiguration

org.apache.flink.configuration.Configuration applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine)
                                                                             throws org.apache.flink.util.FlinkException

Override configuration settings by specified command line options.

参数:

commandLine - containing the overriding values

返回:

the effective configuration with the overridden configuration settings

抛出:

org.apache.flink.util.FlinkException

parseCommandLineOptions

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

抛出:

CliArgsException