Package org.apache.flink.util

Class ParameterTool

java.lang.Object

org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

org.apache.flink.util.AbstractParameterTool

org.apache.flink.util.ParameterTool

All Implemented Interfaces:

Serializable, Cloneable

@Public
public class ParameterTool
extends AbstractParameterTool

This class provides simple utility methods for reading and parsing program arguments from different sources. Only single value parameter could be supported in args.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	data

Fields inherited from class org.apache.flink.util.AbstractParameterTool

DEFAULT_UNDEFINED, defaultData, NO_VALUE_KEY, unrequestedParameters

Method Summary

Modifier and Type	Method	Description
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).
boolean	equals(Object o)
static ParameterTool	fromArgs(String[] args)	Returns ParameterTool for the given arguments.
static ParameterTool	fromMap(Map<String,String> map)	Returns ParameterTool for the given map.
static ParameterTool	fromPropertiesFile(File file)	Returns ParameterTool for the given Properties file.
static ParameterTool	fromPropertiesFile(InputStream inputStream)	Returns ParameterTool for the given InputStream from Properties file.
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.
Configuration	getConfiguration()	Returns a Configuration object from this ParameterTool.
int	getNumberOfParameters()	Returns number of parameters in ParameterTool.
Properties	getProperties()	Returns a Properties object from this ParameterTool.
boolean	has(String value)	Check if value is set.
int	hashCode()
ParameterTool	mergeWith(ParameterTool other)	Merges two ParameterTool.
Map<String,String>	toMap()	Convert UserConfig into a Map<String, String> representation.

Methods inherited from class org.apache.flink.util.AbstractParameterTool

addToDefaults, get, getBoolean, getBoolean, getByte, getByte, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRequired, getShort, getShort, getUnrequestedParameters

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

data

protected final Map<String,String> data

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

fromPropertiesFile

public static ParameterTool fromPropertiesFile(File file)
                                        throws IOException

Returns ParameterTool for the given Properties file.

Parameters:

file - File object to the properties file

Returns:

A ParameterTool

Throws:

IOException - If the file does not exist

See Also:

Properties

fromPropertiesFile

public static ParameterTool fromPropertiesFile(InputStream inputStream)
                                        throws IOException

Returns ParameterTool for the given InputStream from Properties file.

Parameters:

inputStream - InputStream from 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

equals

public boolean equals(Object o)

Overrides:

equals in class ExecutionConfig.GlobalJobParameters

hashCode

public int hashCode()

Overrides:

hashCode in class ExecutionConfig.GlobalJobParameters

getNumberOfParameters

public int getNumberOfParameters()

Returns number of parameters in ParameterTool.

Specified by:

getNumberOfParameters in class AbstractParameterTool

get

public String get(String key)

Returns the String value for the given key. If the key does not exist it will return null.

Specified by:

get in class AbstractParameterTool

has

public boolean has(String value)

Check if value is set.

Specified by:

has in class AbstractParameterTool

getConfiguration

public 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

Specified by:

clone in class AbstractParameterTool

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()

Description copied from class: ExecutionConfig.GlobalJobParameters

Convert UserConfig into a Map<String, String> representation. This can be used by the runtime, for example for presenting the user config in the web frontend.

Specified by:

toMap in class AbstractParameterTool

Returns:

Key/Value representation of the UserConfig