org.apache.flink.connector.testframe.container

Class FlinkContainersSettings

java.lang.Object

org.apache.flink.connector.testframe.container.FlinkContainersSettings

public class FlinkContainersSettings
extends Object

The central configuration holder for Flink container-based test environments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlinkContainersSettings.Builder FlinkContainersConfig builder static inner class.

Method Summary

Modifier and Type	Method and Description
static FlinkContainersSettings	basedOn(Configuration config) FlinkContainersConfig based on provided Flink configuration.
static FlinkContainersSettings.Builder	builder() A new builder for FlinkContainersConfig.
static FlinkContainersSettings	defaultConfig() FlinkContainersConfig based on defaults.
String	getBaseImage() Gets base image.
String	getCheckpointPath() Gets checkpoint path.
static String	getDefaultCheckpointPath() Gets default checkpoint path.
static String	getDefaultFlinkHome() Gets default flink home.
Configuration	getFlinkConfig() Gets flink configuration.
String	getFlinkDistLocation() Gets flink dist location.
String	getFlinkHome() Gets flink home.
String	getHaStoragePath() Gets HA storage path.
String	getHaStoragePathUri() Gets ha storage path uri.
Collection<String>	getJarPaths() Gets jar paths.
String	getJobManagerHostname() Gets job manager hostname.
Properties	getLogProperties() Gets logging properties.
int	getNumSlotsPerTaskManager() Gets number slots per task manager.
int	getNumTaskManagers() Gets number of task managers.
String	getTaskManagerHostnamePrefix() Gets task manager hostname prefix.
String	getZookeeperHostname() Gets Zookeeper hostname.
Boolean	isBuildFromFlinkDist() Returns whether to build from flink-dist or from an existing base container.
Boolean	isZookeeperHA() Is zookeeper HA boolean.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static FlinkContainersSettings.Builder builder()

A new builder for FlinkContainersConfig.

Returns:

The builder.

defaultConfig

public static FlinkContainersSettings defaultConfig()

FlinkContainersConfig based on defaults.

Returns:

The Flink containers config.

basedOn

public static FlinkContainersSettings basedOn(Configuration config)

FlinkContainersConfig based on provided Flink configuration.

Parameters:

config - The config.

Returns:

The flink containers config.

getBaseImage

public String getBaseImage()

Gets base image.

Returns:

The base image.

getNumTaskManagers

public int getNumTaskManagers()

Gets number of task managers.

Returns:

The number task managers.

getNumSlotsPerTaskManager

public int getNumSlotsPerTaskManager()

Gets number slots per task manager.

Returns:

The number slots per task manager.

getJarPaths

public Collection<String> getJarPaths()

Gets jar paths.

Returns:

The jar paths.

getFlinkConfig

public Configuration getFlinkConfig()

Gets flink configuration.

Returns:

The flink configuration.

getTaskManagerHostnamePrefix

public String getTaskManagerHostnamePrefix()

Gets task manager hostname prefix.

Returns:

The task manager hostname prefix.

getJobManagerHostname

public String getJobManagerHostname()

Gets job manager hostname.

Returns:

The job manager hostname.

isBuildFromFlinkDist

public Boolean isBuildFromFlinkDist()

Returns whether to build from flink-dist or from an existing base container. Also see the baseImage property.

getFlinkDistLocation

public String getFlinkDistLocation()

Gets flink dist location.

Returns:

The flink dist location.

getFlinkHome

public String getFlinkHome()

Gets flink home.

Returns:

The flink home path.

getCheckpointPath

public String getCheckpointPath()

Gets checkpoint path.

Returns:

The checkpoint path.

getHaStoragePath

public String getHaStoragePath()

Gets HA storage path.

Returns:

The ha storage path.

getHaStoragePathUri

public String getHaStoragePathUri()

Gets ha storage path uri.

Returns:

The HA storage path as URI (prefixed with file://).

getDefaultFlinkHome

public static String getDefaultFlinkHome()

Gets default flink home.

Returns:

The default flink home path.

getDefaultCheckpointPath

public static String getDefaultCheckpointPath()

Gets default checkpoint path.

Returns:

The default checkpoint path.

isZookeeperHA

public Boolean isZookeeperHA()

Is zookeeper HA boolean.

getZookeeperHostname

public String getZookeeperHostname()

Gets Zookeeper hostname.

Returns:

The Zookeeper hostname.

getLogProperties

public Properties getLogProperties()

Gets logging properties.

Returns:

The logging properties.