org.apache.flink.connector.kafka.dynamic.source

Class DynamicKafkaSourceBuilder<T>

java.lang.Object

org.apache.flink.connector.kafka.dynamic.source.DynamicKafkaSourceBuilder<T>

@Experimental
public class DynamicKafkaSourceBuilder<T>
extends Object

A builder class to make it easier for users to construct a DynamicKafkaSource.

Method Summary

Modifier and Type	Method and Description
DynamicKafkaSource<T>	build() Construct the source with the configuration that was set.
DynamicKafkaSourceBuilder<T>	setBounded(OffsetsInitializer stoppingOffsetsInitializer) Set the source in bounded mode and specify what offsets to end at.
DynamicKafkaSourceBuilder<T>	setClientIdPrefix(String prefix) Set the client id prefix.
DynamicKafkaSourceBuilder<T>	setDeserializer(KafkaRecordDeserializationSchema<T> recordDeserializer) Set the KafkaRecordDeserializationSchema.
DynamicKafkaSourceBuilder<T>	setGroupId(String groupId) Set the property for CommonClientConfigs.GROUP_ID_CONFIG.
DynamicKafkaSourceBuilder<T>	setKafkaMetadataService(KafkaMetadataService kafkaMetadataService) Set the KafkaMetadataService.
DynamicKafkaSourceBuilder<T>	setKafkaStreamSubscriber(KafkaStreamSubscriber kafkaStreamSubscriber) Set a custom Kafka stream subscriber.
DynamicKafkaSourceBuilder<T>	setProperties(Properties properties) Set the properties of the consumers.
DynamicKafkaSourceBuilder<T>	setProperty(String key, String value) Set a property for the consumers.
DynamicKafkaSourceBuilder<T>	setStartingOffsets(OffsetsInitializer startingOffsetsInitializer) Set the starting offsets of the stream.
DynamicKafkaSourceBuilder<T>	setStreamIds(Set<String> streamIds) Set the stream ids belonging to the KafkaMetadataService.
DynamicKafkaSourceBuilder<T>	setStreamPattern(Pattern streamPattern) Set the stream pattern to determine stream ids belonging to the KafkaMetadataService.

Methods inherited from class java.lang.Object

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

Method Detail

setStreamIds

public DynamicKafkaSourceBuilder<T> setStreamIds(Set<String> streamIds)

Set the stream ids belonging to the KafkaMetadataService.

Parameters:

streamIds - the stream ids.

Returns:

the builder.

setStreamPattern

public DynamicKafkaSourceBuilder<T> setStreamPattern(Pattern streamPattern)

Set the stream pattern to determine stream ids belonging to the KafkaMetadataService.

Parameters:

streamPattern - the stream pattern.

Returns:

the builder.

setKafkaStreamSubscriber

public DynamicKafkaSourceBuilder<T> setKafkaStreamSubscriber(KafkaStreamSubscriber kafkaStreamSubscriber)

Set a custom Kafka stream subscriber.

Parameters:

kafkaStreamSubscriber - the KafkaStreamSubscriber.

Returns:

the builder.

setBounded

public DynamicKafkaSourceBuilder<T> setBounded(OffsetsInitializer stoppingOffsetsInitializer)

Set the source in bounded mode and specify what offsets to end at. This is used for all clusters.

Parameters:

stoppingOffsetsInitializer - the OffsetsInitializer.

Returns:

the builder.

setKafkaMetadataService

public DynamicKafkaSourceBuilder<T> setKafkaMetadataService(KafkaMetadataService kafkaMetadataService)

Set the KafkaMetadataService.

Parameters:

kafkaMetadataService - the KafkaMetadataService.

Returns:

the builder.

setDeserializer

public DynamicKafkaSourceBuilder<T> setDeserializer(KafkaRecordDeserializationSchema<T> recordDeserializer)

Set the KafkaRecordDeserializationSchema.

Parameters:

recordDeserializer - the KafkaRecordDeserializationSchema.

Returns:

the builder.

setStartingOffsets

public DynamicKafkaSourceBuilder<T> setStartingOffsets(OffsetsInitializer startingOffsetsInitializer)

Set the starting offsets of the stream. This will be applied to all clusters.

Parameters:

startingOffsetsInitializer - the OffsetsInitializer.

Returns:

the builder.

setProperties

public DynamicKafkaSourceBuilder<T> setProperties(Properties properties)

Set the properties of the consumers. This will be applied to all clusters and properties like CommonClientConfigs.BOOTSTRAP_SERVERS_CONFIG may be overriden by the KafkaMetadataService.

Parameters:

properties - the properties.

Returns:

the builder.

setProperty

public DynamicKafkaSourceBuilder<T> setProperty(String key,
                                                String value)

Set a property for the consumers. This will be applied to all clusters and properties like CommonClientConfigs.BOOTSTRAP_SERVERS_CONFIG may be overriden by the KafkaMetadataService.

Parameters:

key - the property key.

value - the properties value.

Returns:

the builder.

setGroupId

public DynamicKafkaSourceBuilder<T> setGroupId(String groupId)

Set the property for CommonClientConfigs.GROUP_ID_CONFIG. This will be applied to all clusters.

Parameters:

groupId - the group id.

Returns:

the builder.

setClientIdPrefix

public DynamicKafkaSourceBuilder<T> setClientIdPrefix(String prefix)

Set the client id prefix. This applies KafkaSourceOptions.CLIENT_ID_PREFIX to all clusters.

Parameters:

prefix - the client id prefix.

Returns:

the builder.

build

public DynamicKafkaSource<T> build()

Construct the source with the configuration that was set.

Returns:

the DynamicKafkaSource.