org.apache.flink.configuration

Class PipelineOptions

java.lang.Object

org.apache.flink.configuration.PipelineOptions

@PublicEvolving
public class PipelineOptions
extends Object

The configuration options for job execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipelineOptions.VertexDescriptionMode The mode how we organize description of a vertex.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<Boolean>	ALLOW_UNALIGNED_SOURCE_SPLITS Will be removed in future Flink releases.
static ConfigOption<Boolean>	AUTO_GENERATE_UIDS
static ConfigOption<Boolean>	AUTO_TYPE_REGISTRATION Deprecated. The config is deprecated because it's only used in DataSet API. All Flink DataSet APIs are deprecated since Flink 1.18 and will be removed in a future Flink major version. You can still build your application in DataSet, but you should move to either the DataStream and/or Table API.
static ConfigOption<Duration>	AUTO_WATERMARK_INTERVAL
static ConfigOption<List<String>>	CACHED_FILES
static ConfigOption<List<String>>	CLASSPATHS A list of URLs that are added to the classpath of each user code classloader of the program.
static ConfigOption<ExecutionConfig.ClosureCleanerLevel>	CLOSURE_CLEANER_LEVEL
static ConfigOption<Boolean>	FORCE_AVRO
static ConfigOption<Boolean>	FORCE_KRYO
static ConfigOption<Boolean>	GENERIC_TYPES
static ConfigOption<Map<String,String>>	GLOBAL_JOB_PARAMETERS
static ConfigOption<List<String>>	JARS A list of jar files that contain the user-defined function (UDF) classes and all classes used from within the UDFs.
static ConfigOption<List<String>>	KRYO_DEFAULT_SERIALIZERS
static ConfigOption<List<String>>	KRYO_REGISTERED_CLASSES
static ConfigOption<Integer>	MAX_PARALLELISM
static ConfigOption<String>	NAME The job name used for printing and logging.
static ConfigOption<Boolean>	OBJECT_REUSE
static ConfigOption<Boolean>	OPERATOR_CHAINING
static ConfigOption<Boolean>	OPERATOR_CHAINING_CHAIN_OPERATORS_WITH_DIFFERENT_MAX_PARALLELISM
static ConfigOption<Map<String,String>>	PARALLELISM_OVERRIDES
static ConfigOption<List<String>>	POJO_REGISTERED_CLASSES
static ConfigOption<PipelineOptions.VertexDescriptionMode>	VERTEX_DESCRIPTION_MODE
static ConfigOption<Boolean>	VERTEX_NAME_INCLUDE_INDEX_PREFIX

Constructor Summary

Constructors

Constructor and Description
PipelineOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final ConfigOption<String> NAME

The job name used for printing and logging.

JARS

public static final ConfigOption<List<String>> JARS

A list of jar files that contain the user-defined function (UDF) classes and all classes used from within the UDFs.

CLASSPATHS

public static final ConfigOption<List<String>> CLASSPATHS

A list of URLs that are added to the classpath of each user code classloader of the program. Paths must specify a protocol (e.g. file://) and be accessible on all nodes

AUTO_GENERATE_UIDS

public static final ConfigOption<Boolean> AUTO_GENERATE_UIDS

AUTO_TYPE_REGISTRATION

@Deprecated
public static final ConfigOption<Boolean> AUTO_TYPE_REGISTRATION

Deprecated. The config is deprecated because it's only used in DataSet API. All Flink DataSet APIs are deprecated since Flink 1.18 and will be removed in a future Flink major version. You can still build your application in DataSet, but you should move to either the DataStream and/or Table API.

An option to control whether Flink is automatically registering all types in the user programs with Kryo.

See Also:

FLIP-131: Consolidate the user-facing Dataflow SDKs/APIs (and deprecate the DataSet API

AUTO_WATERMARK_INTERVAL

public static final ConfigOption<Duration> AUTO_WATERMARK_INTERVAL

CLOSURE_CLEANER_LEVEL

public static final ConfigOption<ExecutionConfig.ClosureCleanerLevel> CLOSURE_CLEANER_LEVEL

FORCE_AVRO

public static final ConfigOption<Boolean> FORCE_AVRO

FORCE_KRYO

public static final ConfigOption<Boolean> FORCE_KRYO

GENERIC_TYPES

public static final ConfigOption<Boolean> GENERIC_TYPES

GLOBAL_JOB_PARAMETERS

public static final ConfigOption<Map<String,String>> GLOBAL_JOB_PARAMETERS

PARALLELISM_OVERRIDES

public static final ConfigOption<Map<String,String>> PARALLELISM_OVERRIDES

MAX_PARALLELISM

public static final ConfigOption<Integer> MAX_PARALLELISM

OBJECT_REUSE

public static final ConfigOption<Boolean> OBJECT_REUSE

KRYO_DEFAULT_SERIALIZERS

public static final ConfigOption<List<String>> KRYO_DEFAULT_SERIALIZERS

KRYO_REGISTERED_CLASSES

public static final ConfigOption<List<String>> KRYO_REGISTERED_CLASSES

POJO_REGISTERED_CLASSES

public static final ConfigOption<List<String>> POJO_REGISTERED_CLASSES

OPERATOR_CHAINING

public static final ConfigOption<Boolean> OPERATOR_CHAINING

OPERATOR_CHAINING_CHAIN_OPERATORS_WITH_DIFFERENT_MAX_PARALLELISM

public static final ConfigOption<Boolean> OPERATOR_CHAINING_CHAIN_OPERATORS_WITH_DIFFERENT_MAX_PARALLELISM

CACHED_FILES

public static final ConfigOption<List<String>> CACHED_FILES

VERTEX_DESCRIPTION_MODE

public static final ConfigOption<PipelineOptions.VertexDescriptionMode> VERTEX_DESCRIPTION_MODE

VERTEX_NAME_INCLUDE_INDEX_PREFIX

public static final ConfigOption<Boolean> VERTEX_NAME_INCLUDE_INDEX_PREFIX

ALLOW_UNALIGNED_SOURCE_SPLITS

public static final ConfigOption<Boolean> ALLOW_UNALIGNED_SOURCE_SPLITS

Will be removed in future Flink releases.

Constructor Detail

PipelineOptions

public PipelineOptions()