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:

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

public class FlinkYarnSessionCli
extends org.apache.flink.client.cli.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(org.apache.flink.configuration.Configuration configuration, String configurationDirectory, String shortPrefix, String longPrefix)
FlinkYarnSessionCli(org.apache.flink.configuration.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)
void	addRunOptions(org.apache.commons.cli.Options baseOptions)
protected org.apache.flink.configuration.Configuration	applyCommandLineOptionsToConfiguration(org.apache.commons.cli.CommandLine commandLine)
AbstractYarnClusterDescriptor	createClusterDescriptor(org.apache.commons.cli.CommandLine commandLine)
org.apache.hadoop.yarn.api.records.ApplicationId	getClusterId(org.apache.commons.cli.CommandLine commandLine)
org.apache.flink.client.deployment.ClusterSpecification	getClusterSpecification(org.apache.commons.cli.CommandLine commandLine)
static Map<String,String>	getDynamicProperties(String dynamicPropertiesEncoded)
String	getId()
static File	getYarnPropertiesLocation(String yarnPropertiesFileLocation)
boolean	isActive(org.apache.commons.cli.CommandLine commandLine)
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(org.apache.flink.configuration.Configuration configuration,
                           String configurationDirectory,
                           String shortPrefix,
                           String longPrefix)
                    throws org.apache.flink.util.FlinkException

Throws:

org.apache.flink.util.FlinkException

FlinkYarnSessionCli

public FlinkYarnSessionCli(org.apache.flink.configuration.Configuration configuration,
                           String configurationDirectory,
                           String shortPrefix,
                           String longPrefix,
                           boolean acceptInteractiveInput)
                    throws org.apache.flink.util.FlinkException

Throws:

org.apache.flink.util.FlinkException

Method Detail

isActive

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

getId

public String getId()

addRunOptions

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

Specified by:

addRunOptions in interface org.apache.flink.client.cli.CustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

Overrides:

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

addGeneralOptions

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

Specified by:

addGeneralOptions in interface org.apache.flink.client.cli.CustomCommandLine<org.apache.hadoop.yarn.api.records.ApplicationId>

Overrides:

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

createClusterDescriptor

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

Throws:

org.apache.flink.util.FlinkException

getClusterId

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

getClusterSpecification

public org.apache.flink.client.deployment.ClusterSpecification getClusterSpecification(org.apache.commons.cli.CommandLine commandLine)
                                                                                throws org.apache.flink.util.FlinkException

Throws:

org.apache.flink.util.FlinkException

applyCommandLineOptionsToConfiguration

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

Overrides:

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

Throws:

org.apache.flink.util.FlinkException

run

public int run(String[] args)
        throws org.apache.flink.client.cli.CliArgsException,
               org.apache.flink.util.FlinkException

Throws:

org.apache.flink.client.cli.CliArgsException

org.apache.flink.util.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)