ParameterTool (flink-java 1.10.3 API)

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

所有已实现的接口:

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.

另请参阅:

序列化表格

字段概要

字段
限定符和类型字段和说明

protected Map<String,String> data
- 从类继承的字段 org.apache.flink.api.java.utils.AbstractParameterTool
  DEFAULT_UNDEFINED, defaultData, NO_VALUE_KEY, unrequestedParameters

字段
限定符和类型	字段和说明
`protected Map<String,String>`	`data`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`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.
`org.apache.flink.configuration.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()`

从类继承的方法 org.apache.flink.api.java.utils.AbstractParameterTool
addToDefaults, get, getBoolean, getBoolean, getByte, getByte, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRequired, getShort, getShort, getUnrequestedParameters

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - data
```
protected final Map<String,String> data
```
- 方法详细资料
  - 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
    
    参数:
    
    args - Input array arguments
    
    返回:
    
    A ParameterTool
  - fromPropertiesFile
```
public static ParameterTool fromPropertiesFile(String path)
                                        throws IOException
```
    Returns ParameterTool for the given Properties file.
    
    参数:
    
    path - Path to the properties file
    
    返回:
    
    A ParameterTool
    
    抛出:
    
    IOException - If the file does not exist
    
    另请参阅:
    
    Properties
  - fromPropertiesFile
```
public static ParameterTool fromPropertiesFile(File file)
                                        throws IOException
```
    Returns ParameterTool for the given Properties file.
    
    参数:
    
    file - File object to the properties file
    
    返回:
    
    A ParameterTool
    
    抛出:
    
    IOException - If the file does not exist
    
    另请参阅:
    
    Properties
  - fromPropertiesFile
```
public static ParameterTool fromPropertiesFile(InputStream inputStream)
                                        throws IOException
```
    Returns ParameterTool for the given InputStream from Properties file.
    
    参数:
    
    inputStream - InputStream from the properties file
    
    返回:
    
    A ParameterTool
    
    抛出:
    
    IOException - If the file does not exist
    
    另请参阅:
    
    Properties
  - fromMap
```
public static ParameterTool fromMap(Map<String,String> map)
```
    Returns ParameterTool for the given map.
    
    参数:
    
    map - A map of arguments. Both Key and Value have to be Strings
    
    返回:
    
    A ParameterTool
  - fromSystemProperties
```
public static ParameterTool fromSystemProperties()
```
    Returns ParameterTool from the system properties. Example on how to pass system properties: -Dkey1=value1 -Dkey2=value2
    
    返回:
    
    A ParameterTool
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters
  - getNumberOfParameters
```
public int getNumberOfParameters()
```
    Returns number of parameters in ParameterTool.
    
    指定者:
    
    getNumberOfParameters 在类中 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.
    
    指定者:
    
    get 在类中 AbstractParameterTool
  - has
```
public boolean has(String value)
```
    Check if value is set.
    
    指定者:
    
    has 在类中 AbstractParameterTool
  - getConfiguration
```
public org.apache.flink.configuration.Configuration getConfiguration()
```
    Returns a Configuration object from this ParameterTool.
    
    返回:
    
    A Configuration
  - getProperties
```
public Properties getProperties()
```
    Returns a Properties object from this ParameterTool.
    
    返回:
    
    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.
    
    参数:
    
    pathToFile - Location of the default properties file.
    
    抛出:
    
    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.
    
    参数:
    
    pathToFile - Location of the default properties file.
    
    overwrite - Boolean flag indicating whether or not to overwrite the file
    
    抛出:
    
    IOException - If overwrite is not allowed and the file exists
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    指定者:
    
    clone 在类中 AbstractParameterTool
    
    抛出:
    
    CloneNotSupportedException
  - mergeWith
```
public ParameterTool mergeWith(ParameterTool other)
```
    Merges two ParameterTool.
    
    参数:
    
    other - Other ParameterTool object
    
    返回:
    
    The Merged ParameterTool
  - toMap
```
public Map<String,String> toMap()
```
    指定者:
    
    toMap 在类中 AbstractParameterTool

类 ParameterTool

字段概要

从类继承的字段 org.apache.flink.api.java.utils.AbstractParameterTool

方法概要

从类继承的方法 org.apache.flink.api.java.utils.AbstractParameterTool

从类继承的方法 java.lang.Object

字段详细资料

data

方法详细资料

fromArgs

fromPropertiesFile

fromPropertiesFile

fromPropertiesFile

fromMap

fromSystemProperties

equals

hashCode

getNumberOfParameters

get

has

getConfiguration

getProperties

createPropertiesFile

createPropertiesFile

clone

mergeWith

toMap