org.apache.flink.configuration

Class ConfigOptions.OptionBuilder

java.lang.Object

org.apache.flink.configuration.ConfigOptions.OptionBuilder

Enclosing class:

ConfigOptions

public static final class ConfigOptions.OptionBuilder
extends Object

The option builder is used to create a ConfigOption. It is instantiated via ConfigOptions.key(String).

Method Summary

Modifier and Type	Method and Description
ConfigOptions.TypedConfigOptionBuilder<Boolean>	booleanType() Defines that the value of the option should be of Boolean type.
<T> ConfigOption<T>	defaultValue(T value) Deprecated. define the type explicitly first with one of the intType(), stringType(), etc.
ConfigOptions.TypedConfigOptionBuilder<Double>	doubleType() Defines that the value of the option should be of Double type.
ConfigOptions.TypedConfigOptionBuilder<java.time.Duration>	durationType() Defines that the value of the option should be of Duration type.
<T extends Enum<T>> ConfigOptions.TypedConfigOptionBuilder<T>	enumType(Class<T> enumClass) Defines that the value of the option should be of Enum type.
ConfigOptions.TypedConfigOptionBuilder<Float>	floatType() Defines that the value of the option should be of Float type.
ConfigOptions.TypedConfigOptionBuilder<Integer>	intType() Defines that the value of the option should be of Integer type.
ConfigOptions.TypedConfigOptionBuilder<Long>	longType() Defines that the value of the option should be of Long type.
ConfigOptions.TypedConfigOptionBuilder<Map<String,String>>	mapType() Defines that the value of the option should be a set of properties, which can be represented as Map<String, String>.
ConfigOptions.TypedConfigOptionBuilder<MemorySize>	memoryType() Defines that the value of the option should be of MemorySize type.
ConfigOption<String>	noDefaultValue() Deprecated. define the type explicitly first with one of the intType(), stringType(), etc.
ConfigOptions.TypedConfigOptionBuilder<String>	stringType() Defines that the value of the option should be of String type.

Methods inherited from class java.lang.Object

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

Method Detail

booleanType

public ConfigOptions.TypedConfigOptionBuilder<Boolean> booleanType()

Defines that the value of the option should be of Boolean type.

intType

public ConfigOptions.TypedConfigOptionBuilder<Integer> intType()

Defines that the value of the option should be of Integer type.

longType

public ConfigOptions.TypedConfigOptionBuilder<Long> longType()

Defines that the value of the option should be of Long type.

floatType

public ConfigOptions.TypedConfigOptionBuilder<Float> floatType()

Defines that the value of the option should be of Float type.

doubleType

public ConfigOptions.TypedConfigOptionBuilder<Double> doubleType()

Defines that the value of the option should be of Double type.

stringType

public ConfigOptions.TypedConfigOptionBuilder<String> stringType()

Defines that the value of the option should be of String type.

durationType

public ConfigOptions.TypedConfigOptionBuilder<java.time.Duration> durationType()

Defines that the value of the option should be of Duration type.

memoryType

public ConfigOptions.TypedConfigOptionBuilder<MemorySize> memoryType()

Defines that the value of the option should be of MemorySize type.

enumType

public <T extends Enum<T>> ConfigOptions.TypedConfigOptionBuilder<T> enumType(Class<T> enumClass)

Defines that the value of the option should be of Enum type.

Parameters:

enumClass - Concrete type of the expected enum.

mapType

public ConfigOptions.TypedConfigOptionBuilder<Map<String,String>> mapType()

Defines that the value of the option should be a set of properties, which can be represented as Map<String, String>.

defaultValue

@Deprecated
public <T> ConfigOption<T> defaultValue(T value)

Deprecated. define the type explicitly first with one of the intType(), stringType(), etc.

Creates a ConfigOption with the given default value.

This method does not accept "null". For options with no default value, choose one of the noDefaultValue methods.

Type Parameters:

T - The type of the default value.

Parameters:

value - The default value for the config option

Returns:

The config option with the default value.

noDefaultValue

@Deprecated
public ConfigOption<String> noDefaultValue()

Deprecated. define the type explicitly first with one of the intType(), stringType(), etc.

Creates a string-valued option with no default value. String-valued options are the only ones that can have no default value.

Returns:

The created ConfigOption.