org.apache.flink.connector.pulsar.common.config

Class PulsarConfigBuilder

java.lang.Object

org.apache.flink.connector.pulsar.common.config.PulsarConfigBuilder

@Internal
public final class PulsarConfigBuilder
extends Object

A builder for building the unmodifiable Configuration instance. Providing the common validate logic for Pulsar source & sink.

Constructor Summary

Constructors

Constructor and Description
PulsarConfigBuilder()

Method Summary

Modifier and Type	Method and Description
<T extends PulsarConfiguration> T	build(PulsarConfigValidator validator, java.util.function.Function<org.apache.flink.configuration.Configuration,T> constructor) Validate the current config instance and return a unmodifiable configuration.
<T> boolean	contains(org.apache.flink.configuration.ConfigOption<T> option) Validate if the config has a existed option.
<T> T	get(org.apache.flink.configuration.ConfigOption<T> key) Get an option-related config value.
<T> void	override(org.apache.flink.configuration.ConfigOption<T> option, T value) Override the option with the given value.
<T> void	set(org.apache.flink.configuration.ConfigOption<T> option, T value) Add a config option with a not null value.
void	set(org.apache.flink.configuration.Configuration config) Fill in a set of configs which shouldn't be duplicated.
void	set(Properties properties) Fill in a set of config properties which shouldn't be duplicated.

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsarConfigBuilder

public PulsarConfigBuilder()

Method Detail

contains

public <T> boolean contains(org.apache.flink.configuration.ConfigOption<T> option)

Validate if the config has a existed option.

get

public <T> T get(org.apache.flink.configuration.ConfigOption<T> key)

Get an option-related config value. We would return the default config value defined in the option if no value existed instead.

Parameters:

key - Config option instance.

set

public <T> void set(org.apache.flink.configuration.ConfigOption<T> option,
                    T value)

Add a config option with a not null value. The config key shouldn't be duplicated.

Parameters:

option - Config option instance, contains key & type definition.

value - The config value which shouldn't be null.

set

public void set(org.apache.flink.configuration.Configuration config)

Fill in a set of configs which shouldn't be duplicated.

Parameters:

config - A set of configs.

set

public void set(Properties properties)

Fill in a set of config properties which shouldn't be duplicated.

Parameters:

properties - A config which could be string type.

override

public <T> void override(org.apache.flink.configuration.ConfigOption<T> option,
                         T value)

Override the option with the given value. It will not check the existed option comparing to set(ConfigOption, Object).

build

public <T extends PulsarConfiguration> T build(PulsarConfigValidator validator,
                                               java.util.function.Function<org.apache.flink.configuration.Configuration,T> constructor)

Validate the current config instance and return a unmodifiable configuration.