Package org.apache.flink.configuration

Class 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");