Package org.apache.flink.configuration

Interface Summary

Interface	Description
DescribedEnum	Describe enum constants used in ConfigOptions.
ReadableConfig	Read access to a configuration object.
WritableConfig	Write access to a configuration object.

Class Summary

Class	Description
AlgorithmOptions	Configuration parameters for join/sort algorithms.
BatchExecutionOptions	Configuration options for the batch job execution.
BlobServerOptions	Configuration options for the BlobServer and BlobCache.
CheckpointingOptions	A collection of all configuration options that relate to checkpoints and savepoints.
CleanupOptions	ConfigOption collection for the configuration of repeatable cleanup of resource cleanup after a job reached a globally-terminated state.
ClusterOptions	Options which control the cluster behaviour.
ConfigConstants	This class contains all constants for the configuration.
ConfigOption<T>	A ConfigOption describes a configuration parameter.
ConfigOptions	ConfigOptions are used to build a ConfigOption.
ConfigOptions.ListConfigOptionBuilder<E>	Builder for ConfigOption of list of type ConfigOptions.ListConfigOptionBuilder.
ConfigOptions.OptionBuilder	The option builder is used to create a ConfigOption.
ConfigOptions.TypedConfigOptionBuilder<T>	Builder for ConfigOption with a defined atomic type.
Configuration	Lightweight configuration object which stores key/value pairs.
ConfigurationFileMigrationUtils	Utility class for migrating legacy Flink configuration file flink-conf.yaml to the new format starting from Flink 2.0.
ConfigurationUtils	Utility class for Configuration related helper functions.
ConfigUtils	General utilities for parsing values to configuration options.
CoreOptions	The set of configuration options for core parameters.
DelegatingConfiguration	A configuration that manages a subset of keys with a common prefix from a given configuration.
DeploymentOptions	The configuration options relevant for all Executors.
DeploymentOptionsInternal	Internal options used during deployment.
ExecutionOptions	ConfigOptions specific for a single execution of a user program.
ExternalResourceOptions	Configuration options for external resources and external resource drivers.
FallbackKey	A key with FallbackKeys will fall back to the FallbackKeys if it itself is not configured.
GlobalConfiguration	Global configuration object for Flink.
HeartbeatManagerOptions	The set of configuration options relating to heartbeat manager settings.
HighAvailabilityOptions	The set of configuration options relating to high-availability settings.
HistoryServerOptions	The set of configuration options relating to the HistoryServer.
JMXServerOptions	The set of configuration options relating to JMX server.
JobEventStoreOptions	Configuration options for the job events.
JobManagerOptions	Configuration options for the JobManager.
MemorySize	MemorySize is a representation of a number of bytes, viewable in different units.
MetricOptions	Configuration options for metrics and metric reporters.
MetricOptions.JobStatusMetricsSettings	Describes which job status metrics have been enabled.
NettyShuffleEnvironmentOptions	The set of configuration options relating to network stack.
OptimizerOptions	Configuration options for the optimizer.
PipelineOptions	The configuration options for job execution.
PipelineOptionsInternal	Pipeline options that are not meant to be used by the user.
QueryableStateOptions	Deprecated. The Queryable State feature is deprecated since Flink 1.18, and will be removed in a future Flink major version.
ResourceManagerOptions	The set of configuration options relating to the ResourceManager.
RestartStrategyOptions	Config options for restart strategies.
RestOptions	Configuration parameters for REST communication.
RpcOptions	RPC configuration options.
SecurityOptions	The set of configuration options relating to security.
SinkOptions	Configuration options for sinks.
SlowTaskDetectorOptions	Configuration options to detect slow tasks.
StateBackendOptions	A collection of all configuration options that relate to state backend.
StateChangelogOptions	A collection of all configuration options that relate to changelog.
StateLatencyTrackOptions	A collection of all configuration options that relate to the latency tracking for state access.
StateRecoveryOptions	The configuration options used when restoring state from a savepoint or a checkpoint.
TaskManagerOptions	The set of configuration options relating to TaskManager and Task settings.
TaskManagerOptionsInternal	TaskManager options that are not meant to be used by the user.
TraceOptions	Configuration options for traces and trace reporters.
UnmodifiableConfiguration	Unmodifiable version of the Configuration class.
WebOptions	Configuration options for the WebMonitorEndpoint.
YamlParserUtils	This class contains utility methods to load standard yaml file and convert object to standard yaml syntax.

Enum Summary

Enum	Description
ClusterOptions.UncaughtExceptionHandleMode
ClusterOptions.UserSystemExitMode	The mode of how to handle user code attempting to exit JVM.
ExternalizedCheckpointRetention	Cleanup behaviour for externalized checkpoints when the job is cancelled.
JobManagerOptions.HybridPartitionDataConsumeConstraint	Constraints of upstream hybrid partition data consumption by downstream.
JobManagerOptions.JobStoreType	Type of job store implementation.
JobManagerOptions.SchedulerType	Type of scheduler implementation.
MemorySize.MemoryUnit	Enum which defines memory unit, mostly used to parse value from configuration file.
MetricOptions.JobStatusMetrics	Enum describing the different kinds of job status metrics.
NettyShuffleEnvironmentOptions.CompressionCodec	Supported compression codec.
PipelineOptions.VertexDescriptionMode	The mode how we organize description of a vertex.
RestartStrategyOptions.RestartStrategyType	The restart strategy type.
SchedulerExecutionMode	Enum for controlling whether REACTIVE mode is enabled or not.
TaskManagerOptions.SystemOutMode	Type of redirection of System.out and System.err.
TaskManagerOptions.TaskManagerLoadBalanceMode	Type of TaskManagerOptions.TASK_MANAGER_LOAD_BALANCE_MODE.

Exception Summary

Exception	Description
IllegalConfigurationException	An IllegalConfigurationException is thrown when the values in a given Configuration are not valid.