org.apache.flink.yarn.cli

Class FlinkYarnSessionCli

java.lang.Object

org.apache.flink.client.cli.AbstractCustomCommandLine

org.apache.flink.yarn.cli.FlinkYarnSessionCli

All Implemented Interfaces:

CustomCommandLine

public class FlinkYarnSessionCli
extends AbstractCustomCommandLine

Class handling the command line interface to the YARN session.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.cli.Option	addressOption
protected org.apache.commons.cli.Option	applicationId
protected Configuration	configuration
static String	ID

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

zookeeperNamespaceOption

Constructor Summary

Constructors

Constructor and Description
FlinkYarnSessionCli(Configuration configuration, ClusterClientServiceLoader clusterClientServiceLoader, String configurationDirectory, String shortPrefix, String longPrefix, boolean acceptInteractiveInput)
FlinkYarnSessionCli(Configuration configuration, String configurationDirectory, String shortPrefix, String longPrefix)
FlinkYarnSessionCli(Configuration configuration, String configurationDirectory, String shortPrefix, String longPrefix, boolean acceptInteractiveInput)

Method Summary

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.
static Map<String,String>	getDynamicProperties(String dynamicPropertiesEncoded)
String	getId() Gets the unique identifier of this CustomCommandLine.
static File	getYarnPropertiesLocation(String yarnPropertiesFileLocation)
boolean	isActive(org.apache.commons.cli.CommandLine commandLine) Signals whether the custom command-line wants to execute or not.
static void	main(String[] args)
int	run(String[] args)
Configuration	toConfiguration(org.apache.commons.cli.CommandLine commandLine) Materializes the command line arguments in the given CommandLine to a Configuration and returns it.

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

handleCliArgsException, handleError, printUsage

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

applicationId

protected final org.apache.commons.cli.Option applicationId

addressOption

protected final org.apache.commons.cli.Option addressOption

configuration

protected final Configuration configuration

Constructor Detail

FlinkYarnSessionCli

public FlinkYarnSessionCli(Configuration configuration,
                           String configurationDirectory,
                           String shortPrefix,
                           String longPrefix)
                    throws FlinkException

Throws:

FlinkException

FlinkYarnSessionCli

public FlinkYarnSessionCli(Configuration configuration,
                           String configurationDirectory,
                           String shortPrefix,
                           String longPrefix,
                           boolean acceptInteractiveInput)
                    throws FlinkException

Throws:

FlinkException

FlinkYarnSessionCli

public FlinkYarnSessionCli(Configuration configuration,
                           ClusterClientServiceLoader clusterClientServiceLoader,
                           String configurationDirectory,
                           String shortPrefix,
                           String longPrefix,
                           boolean acceptInteractiveInput)
                    throws FlinkException

Throws:

FlinkException

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.

Specified by:

isActive in interface CustomCommandLine

Parameters:

commandLine - The command-line options

Returns:

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

addRunOptions

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

Description copied from interface: CustomCommandLine

Adds custom options to the existing run options.

Specified by:

addRunOptions in interface CustomCommandLine

Overrides:

addRunOptions in class AbstractCustomCommandLine

Parameters:

baseOptions - The existing options.

toConfiguration

public Configuration toConfiguration(org.apache.commons.cli.CommandLine commandLine)
                              throws FlinkException

Description copied from interface: CustomCommandLine

Materializes the command line arguments in the given CommandLine to a Configuration and returns it.

Specified by:

toConfiguration in interface CustomCommandLine

Overrides:

toConfiguration in class AbstractCustomCommandLine

Throws:

FlinkException

run

public int run(String[] args)
        throws CliArgsException,
               FlinkException

Throws:

CliArgsException

FlinkException

getDynamicProperties

public static Map<String,String> getDynamicProperties(String dynamicPropertiesEncoded)

main

public static void main(String[] args)

getYarnPropertiesLocation

public static File getYarnPropertiesLocation(@Nullable
                                             String yarnPropertiesFileLocation)

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

Overrides:

addGeneralOptions in class AbstractCustomCommandLine

Parameters:

baseOptions - The existing options.

getId

public String getId()

Description copied from interface: CustomCommandLine

Gets the unique identifier of this CustomCommandLine.

Returns:

A unique identifier