Package 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:
org.apache.flink.client.cli.CustomCommandLine
public class FlinkYarnSessionCli extends org.apache.flink.client.cli.AbstractCustomCommandLine
Class handling the command line interface to the YARN session.

  • Field Summary

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

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

    zookeeperNamespaceOption

  • Constructor Summary

    Constructors
    Constructor
    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)
     
    FlinkYarnSessionCli(org.apache.flink.configuration.Configuration configuration, org.apache.flink.client.deployment.ClusterClientServiceLoader clusterClientServiceLoader, String configurationDirectory, String shortPrefix, String longPrefix, boolean acceptInteractiveInput)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addGeneralOptions(org.apache.commons.cli.Options baseOptions)
     
    void
    addRunOptions(org.apache.commons.cli.Options baseOptions)
     
    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)
     
    org.apache.flink.configuration.Configuration
    toConfiguration(org.apache.commons.cli.CommandLine commandLine)
     

    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 Details

    • ID

      public static final String ID
      See Also:

    • applicationId

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

    • addressOption

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

    • configuration

      protected final org.apache.flink.configuration.Configuration configuration

  • Constructor Details

    • 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

    • FlinkYarnSessionCli

      public FlinkYarnSessionCli(org.apache.flink.configuration.Configuration configuration, org.apache.flink.client.deployment.ClusterClientServiceLoader clusterClientServiceLoader, String configurationDirectory, String shortPrefix, String longPrefix, boolean acceptInteractiveInput) throws org.apache.flink.util.FlinkException
      Throws:
      org.apache.flink.util.FlinkException

  • Method Details

    • isActive

      public boolean isActive(org.apache.commons.cli.CommandLine commandLine)
      Specified by:
      isActive in interface org.apache.flink.client.cli.CustomCommandLine

    • addRunOptions

      public void addRunOptions(org.apache.commons.cli.Options baseOptions)
      Specified by:
      addRunOptions in interface org.apache.flink.client.cli.CustomCommandLine
      Overrides:
      addRunOptions in class org.apache.flink.client.cli.AbstractCustomCommandLine

    • toConfiguration

      public org.apache.flink.configuration.Configuration toConfiguration(org.apache.commons.cli.CommandLine commandLine) throws org.apache.flink.util.FlinkException
      Specified by:
      toConfiguration in interface org.apache.flink.client.cli.CustomCommandLine
      Overrides:
      toConfiguration in class org.apache.flink.client.cli.AbstractCustomCommandLine
      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)

    • addGeneralOptions

      public void addGeneralOptions(org.apache.commons.cli.Options baseOptions)
      Specified by:
      addGeneralOptions in interface org.apache.flink.client.cli.CustomCommandLine
      Overrides:
      addGeneralOptions in class org.apache.flink.client.cli.AbstractCustomCommandLine

    • getId

      public String getId()