org.apache.flink.configuration

Class ConfigOptions

java.lang.Object

org.apache.flink.configuration.ConfigOptions

@PublicEvolving
public class ConfigOptions
extends Object

ConfigOptions are used to build a ConfigOption. The option is typically built in one of the following pattern:

 // simple string-valued option with a default value
 ConfigOption<String> tempDirs = ConfigOptions
     .key("tmp.dir")
     .stringType()
     .defaultValue("/tmp");

 // simple integer-valued option with a default value
 ConfigOption<Integer> parallelism = ConfigOptions
     .key("application.parallelism")
     .intType()
     .defaultValue(100);

 // option of list of integers with a default value
 ConfigOption<Integer> parallelism = ConfigOptions
     .key("application.ports")
     .intType()
     .asList()
     .defaultValue(8000, 8001, 8002);

 // option with no default value
 ConfigOption<String> userName = ConfigOptions
     .key("user.name")
     .stringType()
     .noDefaultValue();

 // option with deprecated keys to check
 ConfigOption<Double> threshold = ConfigOptions
     .key("cpu.utilization.threshold")
     .doubleType()
     .defaultValue(0.9)
     .withDeprecatedKeys("cpu.threshold");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigOptions.ListConfigOptionBuilder<E> Builder for ConfigOption of list of type E.
static class	ConfigOptions.OptionBuilder The option builder is used to create a ConfigOption.
static class	ConfigOptions.TypedConfigOptionBuilder<T> Builder for ConfigOption with a defined atomic type.

Method Summary

Modifier and Type	Method and Description
static ConfigOptions.OptionBuilder	key(String key) Starts building a new ConfigOption.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

key

public static ConfigOptions.OptionBuilder key(String key)

Starts building a new ConfigOption.

Parameters:

key - The key for the config option.

Returns:

The builder for the config option with the given key.