org.apache.flink.yarn.cli

Class FlinkYarnSessionCli

java.lang.Object

org.apache.flink.client.cli.AbstractCustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

org.apache.flink.yarn.cli.FlinkYarnSessionCli

All Implemented Interfaces:

CustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

public class FlinkYarnSessionCli
extends AbstractCustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

Class handling the command line interface to the YARN session.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILE_LOG4J_NAME
static String	CONFIG_FILE_LOGBACK_NAME

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

addressOption, configuration, zookeeperNamespaceOption

Constructor Summary

Constructors

Constructor and Description
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.
protected Configuration	applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine) Override configuration settings by specified command line options.
AbstractYarnClusterDescriptor	createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine) Create a ClusterDescriptor from the given configuration, configuration directory and the command line.
org.apache.hadoop.yarn.api.records.ApplicationId	getClusterId(org.apache.commons.cli.CommandLine commandLine) Returns the cluster id if a cluster id was specified on the command line, otherwise it returns null.
ClusterSpecification	getClusterSpecification(org.apache.commons.cli.CommandLine commandLine) Returns the ClusterSpecification specified by the configuration and the command line 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)

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

getConfiguration

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

CONFIG_FILE_LOGBACK_NAME

public static final String CONFIG_FILE_LOGBACK_NAME

See Also:

Constant Field Values

CONFIG_FILE_LOG4J_NAME

public static final String CONFIG_FILE_LOG4J_NAME

See Also:

Constant Field Values

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

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.

Parameters:

commandLine - The command-line options

Returns:

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

getId

public String getId()

Description copied from interface: CustomCommandLine

Gets the unique identifier of this CustomCommandLine.

Returns:

A unique identifier

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<org.apache.hadoop.yarn.api.records.ApplicationId>

Overrides:

addRunOptions in class AbstractCustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

Parameters:

baseOptions - The existing options.

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<org.apache.hadoop.yarn.api.records.ApplicationId>

Overrides:

addGeneralOptions in class AbstractCustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

Parameters:

baseOptions - The existing options.

createClusterDescriptor

public AbstractYarnClusterDescriptor createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine)
                                                      throws FlinkException

Description copied from interface: CustomCommandLine

Create a ClusterDescriptor from the given configuration, configuration directory and the command line.

Parameters:

commandLine - containing command line options relevant for the ClusterDescriptor

Returns:

ClusterDescriptor

Throws:

FlinkException - if the ClusterDescriptor could not be created

getClusterId

@Nullable
public org.apache.hadoop.yarn.api.records.ApplicationId getClusterId(org.apache.commons.cli.CommandLine commandLine)

Description copied from interface: CustomCommandLine

Returns the cluster id if a cluster id was specified on the command line, otherwise it returns null.

A cluster id identifies a running cluster, e.g. the Yarn application id for a Flink cluster running on Yarn.

Parameters:

commandLine - containing command line options relevant for the cluster id retrieval

Returns:

Cluster id identifying the cluster to deploy jobs to or null

getClusterSpecification

public ClusterSpecification getClusterSpecification(org.apache.commons.cli.CommandLine commandLine)
                                             throws FlinkException

Description copied from interface: CustomCommandLine

Returns the ClusterSpecification specified by the configuration and the command line options. This specification can be used to deploy a new Flink cluster.

Parameters:

commandLine - containing command line options relevant for the ClusterSpecification

Returns:

ClusterSpecification for a new Flink cluster

Throws:

FlinkException - if the ClusterSpecification could not be created

applyCommandLineOptionsToConfiguration

protected Configuration applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine)
                                                        throws FlinkException

Description copied from class: AbstractCustomCommandLine

Override configuration settings by specified command line options.

Overrides:

applyCommandLineOptionsToConfiguration in class AbstractCustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

Parameters:

commandLine - containing the overriding values

Returns:

Effective configuration with the overridden configuration settings

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)