ParameterTool (flink-java 1.1.1 API)

java.lang.Object
- org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
- - org.apache.flink.api.java.utils.ParameterTool

All Implemented Interfaces:

Serializable, Cloneable
```
@Public
public class ParameterTool
extends org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
implements Serializable, Cloneable
```
This class provides simple utility methods for reading and parsing program arguments from different sources

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`data`
`protected static String`	`DEFAULT_UNDEFINED`
`protected HashMap<String,String>`	`defaultData`
`protected static String`	`NO_VALUE_KEY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addToDefaults(String key, String value)`
`protected Object`	`clone()`
`void`	`createPropertiesFile(String pathToFile)` Create a properties file with all the known parameters (call after the last get*() call).
`void`	`createPropertiesFile(String pathToFile, boolean overwrite)` Create a properties file with all the known parameters (call after the last get*() call).
`static ParameterTool`	`fromArgs(String[] args)` Returns `ParameterTool` for the given arguments.
`static ParameterTool`	`fromGenericOptionsParser(String[] args)` Returns `ParameterTool` for the arguments parsed by `GenericOptionsParser`
`static ParameterTool`	`fromMap(Map<String,String> map)` Returns `ParameterTool` for the given map
`static ParameterTool`	`fromPropertiesFile(String path)` Returns `ParameterTool` for the given `Properties` file
`static ParameterTool`	`fromSystemProperties()` Returns `ParameterTool` from the system properties.
`String`	`get(String key)` Returns the String value for the given key.
`String`	`get(String key, String defaultValue)` Returns the String value for the given key.
`boolean`	`getBoolean(String key)` Returns the Boolean value for the given key.
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns the Boolean value for the given key.
`byte`	`getByte(String key)` Returns the Byte value for the given key.
`byte`	`getByte(String key, byte defaultValue)` Returns the Byte value for the given key.
`org.apache.flink.configuration.Configuration`	`getConfiguration()` Returns a `Configuration` object from this `ParameterTool`
`double`	`getDouble(String key)` Returns the Double value for the given key.
`double`	`getDouble(String key, double defaultValue)` Returns the Double value for the given key.
`float`	`getFloat(String key)` Returns the Float value for the given key.
`float`	`getFloat(String key, float defaultValue)` Returns the Float value for the given key.
`int`	`getInt(String key)` Returns the Integer value for the given key.
`int`	`getInt(String key, int defaultValue)` Returns the Integer value for the given key.
`long`	`getLong(String key)` Returns the Long value for the given key.
`long`	`getLong(String key, long defaultValue)` Returns the Long value for the given key.
`int`	`getNumberOfParameters()` Returns number of parameters in `ParameterTool`.
`Properties`	`getProperties()` Returns a `Properties` object from this `ParameterTool`
`String`	`getRequired(String key)` Returns the String value for the given key.
`short`	`getShort(String key)` Returns the Short value for the given key.
`short`	`getShort(String key, short defaultValue)` Returns the Short value for the given key.
`boolean`	`has(String value)` Check if value is set.
`ParameterTool`	`mergeWith(ParameterTool other)` Merges two `ParameterTool`
`Map<String,String>`	`toMap()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_VALUE_KEY
```
protected static String NO_VALUE_KEY
```
  - DEFAULT_UNDEFINED
```
protected static String DEFAULT_UNDEFINED
```
  - data
```
protected final Map<String,String> data
```
  - defaultData
```
protected final HashMap<String,String> defaultData
```
- Method Detail
  - fromArgs
```
public static ParameterTool fromArgs(String[] args)
```
    Returns ParameterTool for the given arguments. The arguments are keys followed by values. Keys have to start with '-' or '--'
    Example arguments: --key1 value1 --key2 value2 -key3 value3
    
    Parameters:
    
    args - Input array arguments
    
    Returns:
    
    A ParameterTool
  - fromPropertiesFile
```
public static ParameterTool fromPropertiesFile(String path)
                                        throws IOException
```
    Returns ParameterTool for the given Properties file
    
    Parameters:
    
    path - Path to the properties file
    
    Returns:
    
    A ParameterTool
    
    Throws:
    
    IOException - If the file does not exist
    
    See Also:
    
    Properties
  - fromMap
```
public static ParameterTool fromMap(Map<String,String> map)
```
    Returns ParameterTool for the given map
    
    Parameters:
    
    map - A map of arguments. Both Key and Value have to be Strings
    
    Returns:
    
    A ParameterTool
  - fromSystemProperties
```
public static ParameterTool fromSystemProperties()
```
    Returns ParameterTool from the system properties. Example on how to pass system properties: -Dkey1=value1 -Dkey2=value2
    
    Returns:
    
    A ParameterTool
  - fromGenericOptionsParser
```
@PublicEvolving
public static ParameterTool fromGenericOptionsParser(String[] args)
                                                              throws IOException
```
    Returns ParameterTool for the arguments parsed by GenericOptionsParser
    
    Parameters:
    
    args - Input array arguments. It should be parsable by GenericOptionsParser
    
    Returns:
    
    A ParameterTool
    
    Throws:
    
    IOException - If arguments cannot be parsed by GenericOptionsParser
    
    See Also:
    
    GenericOptionsParser
  - getNumberOfParameters
```
public int getNumberOfParameters()
```
    Returns number of parameters in ParameterTool.
  - get
```
public String get(String key)
```
    Returns the String value for the given key. If the key does not exist it will return null.
  - getRequired
```
public String getRequired(String key)
```
    Returns the String value for the given key. If the key does not exist it will throw a RuntimeException.
  - get
```
public String get(String key,
                  String defaultValue)
```
    Returns the String value for the given key. If the key does not exist it will return the given default value.
  - has
```
public boolean has(String value)
```
    Check if value is set.
  - getInt
```
public int getInt(String key)
```
    Returns the Integer value for the given key. The method fails if the key does not exist or the value is not an Integer.
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Returns the Integer value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not an Integer.
  - getLong
```
public long getLong(String key)
```
    Returns the Long value for the given key. The method fails if the key does not exist.
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Returns the Long value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Long.
  - getFloat
```
public float getFloat(String key)
```
    Returns the Float value for the given key. The method fails if the key does not exist.
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Returns the Float value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Float.
  - getDouble
```
public double getDouble(String key)
```
    Returns the Double value for the given key. The method fails if the key does not exist.
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Returns the Double value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Double.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Returns the Boolean value for the given key. The method fails if the key does not exist.
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Returns the Boolean value for the given key. If the key does not exists it will return the default value given. The method returns whether the string of the value is "true" ignoring cases.
  - getShort
```
public short getShort(String key)
```
    Returns the Short value for the given key. The method fails if the key does not exist.
  - getShort
```
public short getShort(String key,
                      short defaultValue)
```
    Returns the Short value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Short.
  - getByte
```
public byte getByte(String key)
```
    Returns the Byte value for the given key. The method fails if the key does not exist.
  - getByte
```
public byte getByte(String key,
                    byte defaultValue)
```
    Returns the Byte value for the given key. If the key does not exists it will return the default value given. The method fails if the value is not a Byte.
  - addToDefaults
```
protected void addToDefaults(String key,
                             String value)
```
  - getConfiguration
```
public org.apache.flink.configuration.Configuration getConfiguration()
```
    Returns a Configuration object from this ParameterTool
    
    Returns:
    
    A Configuration
  - getProperties
```
public Properties getProperties()
```
    Returns a Properties object from this ParameterTool
    
    Returns:
    
    A Properties
  - createPropertiesFile
```
public void createPropertiesFile(String pathToFile)
                          throws IOException
```
    Create a properties file with all the known parameters (call after the last get*() call). Set the default value, if available. Use this method to create a properties file skeleton.
    
    Parameters:
    
    pathToFile - Location of the default properties file.
    
    Throws:
    
    IOException
  - createPropertiesFile
```
public void createPropertiesFile(String pathToFile,
                                 boolean overwrite)
                          throws IOException
```
    Create a properties file with all the known parameters (call after the last get*() call). Set the default value, if overwrite is true.
    
    Parameters:
    
    pathToFile - Location of the default properties file.
    
    overwrite - Boolean flag indicating whether or not to overwrite the file
    
    Throws:
    
    IOException - If overwrite is not allowed and the file exists
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - mergeWith
```
public ParameterTool mergeWith(ParameterTool other)
```
    Merges two ParameterTool
    
    Parameters:
    
    other - Other ParameterTool object
    
    Returns:
    
    The Merged ParameterTool
  - toMap
```
public Map<String,String> toMap()
```
    Overrides:
    
    toMap in class org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

Class ParameterTool

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_VALUE_KEY

DEFAULT_UNDEFINED

data

defaultData

Method Detail

fromArgs

fromPropertiesFile

fromMap

fromSystemProperties

fromGenericOptionsParser

getNumberOfParameters

get

getRequired

get

has

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getBoolean

getBoolean

getShort

getShort

getByte

getByte

addToDefaults

getConfiguration

getProperties

createPropertiesFile

createPropertiesFile

clone

mergeWith

toMap