Package io.confluent.flink.plugin

Class ConfluentSettings

java.lang.Object

io.confluent.flink.plugin.ConfluentSettings

public class ConfluentSettings
extends Object

Entrypoint for Confluent-specific EnvironmentSettings.

Pass these settings into TableEnvironment.create(EnvironmentSettings) for talking to Confluent Cloud.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfluentSettings.Builder	Builder pattern for a fluent definition of Confluent-specific EnvironmentSettings.

Method Summary

Modifier and Type	Method	Description
static EnvironmentSettings	fromArgs(String[] args)	Entrypoint for Confluent-specific EnvironmentSettings.
static EnvironmentSettings	fromFile(File file)	Entrypoint for Confluent-specific EnvironmentSettings.
static EnvironmentSettings	fromFile(String path)
static EnvironmentSettings	fromFile(Path path)
static EnvironmentSettings	fromGlobalVariables()	Entrypoint for Confluent-specific EnvironmentSettings.
static EnvironmentSettings	fromResource(String resourcePath)	Entrypoint for Confluent-specific EnvironmentSettings.
static ConfluentSettings.Builder	newBuilder()	Creates a builder for Confluent-specific EnvironmentSettings.
static ConfluentSettings.Builder	newBuilderFromArgs(String[] args)	Creates a builder for Confluent-specific EnvironmentSettings.
static ConfluentSettings.Builder	newBuilderFromFile(File file)	Creates a builder for Confluent-specific EnvironmentSettings.
static ConfluentSettings.Builder	newBuilderFromFile(String filePath)	Creates a builder for Confluent-specific EnvironmentSettings.
static ConfluentSettings.Builder	newBuilderFromResource(String resourcePath)	Creates a builder for Confluent-specific EnvironmentSettings.

Methods inherited from class java.lang.Object

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

Method Details

fromGlobalVariables

public static EnvironmentSettings fromGlobalVariables()

Entrypoint for Confluent-specific EnvironmentSettings.

It reads all required configuration from global environment variables.

Use newBuilder() for further customization.

ConfluentPluginOptions.VAR_FLINK_PROPERTIES can be used to define fromFile(File) via an environment variable.

fromArgs

public static EnvironmentSettings fromArgs(String[] args)

Entrypoint for Confluent-specific EnvironmentSettings.

This method parses required configuration from Java's main(String[] args). It conveniently enables passing arguments. For example: java -jar MyTableApiProgram.jar --environment-id env-z3y2x1 --organization-id b0b21724-4586-4a07-b787-d0bb5aacbf87.

Global environment variables are the fallback. ConfluentPluginOptions.VAR_FLINK_PROPERTIES can be used to define fromFile(File) via an environment variable. Use newBuilderFromArgs(String[]) for further customization. See ConfluentPluginOptions.ARG_OPTIONS for more information.

fromFile

public static EnvironmentSettings fromFile(String path)

See Also:

• fromFile(File)

fromFile

public static EnvironmentSettings fromFile(Path path)

See Also:

• fromFile(File)

fromFile

public static EnvironmentSettings fromFile(File file)

Entrypoint for Confluent-specific EnvironmentSettings.

This method parses required configuration from a properties file.

Global environment variables are the fallback. Use newBuilderFromFile(File) for further customization.

ConfluentPluginOptions.VAR_FLINK_PROPERTIES can be used to define a path via an environment variable.

fromResource

public static EnvironmentSettings fromResource(String resourcePath)

Entrypoint for Confluent-specific EnvironmentSettings.

This method parses required configuration from a properties file located in project resources.

Global environment variables are the fallback. Use newBuilderFromResource(String) for further customization.

newBuilder

public static ConfluentSettings.Builder newBuilder()

Creates a builder for Confluent-specific EnvironmentSettings.

Global environment variables are the fallback.

ConfluentPluginOptions.VAR_FLINK_PROPERTIES can be used to define fromFile(File) via an environment variable.

newBuilderFromArgs

public static ConfluentSettings.Builder newBuilderFromArgs(String[] args)

Creates a builder for Confluent-specific EnvironmentSettings.

This method parses required configuration from Java's main(String[] args). It conveniently enables passing arguments. For example: java -jar MyTableApiProgram.jar --environment-id env-z3y2x1 --organization-id b0b21724-4586-4a07-b787-d0bb5aacbf87.

Global environment variables are the fallback. ConfluentPluginOptions.VAR_FLINK_PROPERTIES can be used to define a properties file that is applied before the given arguments (arguments take precedence, following last-writer-wins semantics). See ConfluentPluginOptions.ARG_OPTIONS for more information.

Options set in the builder have the highest precedence.

newBuilderFromResource

public static ConfluentSettings.Builder newBuilderFromResource(String resourcePath)

Creates a builder for Confluent-specific EnvironmentSettings.

This method parses required configuration from a properties file located in project resources.

Global environment variables are the fallback.

Options set in the builder have the highest precedence.

newBuilderFromFile

public static ConfluentSettings.Builder newBuilderFromFile(String filePath)

Creates a builder for Confluent-specific EnvironmentSettings.

This method parses required configuration from a properties file.

Global environment variables are the fallback.

Options set in the builder have the highest precedence.

newBuilderFromFile

public static ConfluentSettings.Builder newBuilderFromFile(File file)

Creates a builder for Confluent-specific EnvironmentSettings.

This method parses required configuration from a properties file.

Global environment variables are the fallback.

Options set in the builder have the highest precedence.