org.apache.flink.statefun.sdk.kafka

Class KafkaIngressBuilder<T>

java.lang.Object

org.apache.flink.statefun.sdk.kafka.KafkaIngressBuilder<T>

Type Parameters:

T - The type consumed from Kafka.

public final class KafkaIngressBuilder<T>
extends java.lang.Object

A builder for creating an IngressSpec for consuming data from Apache Kafka.

Method Summary

Modifier and Type	Method and Description
KafkaIngressBuilder<T>	addTopics(java.util.List<java.lang.String> topics)
KafkaIngressSpec<T>	build()
static <T> KafkaIngressBuilder<T>	forIdentifier(IngressIdentifier<T> id)
KafkaIngressBuilder<T>	withAutoResetPosition(KafkaIngressAutoResetPosition autoResetPosition)
KafkaIngressBuilder<T>	withConsumerGroupId(java.lang.String consumerGroupId)
KafkaIngressBuilder<T>	withDeserializer(java.lang.Class<? extends KafkaIngressDeserializer<T>> deserializerClass)
KafkaIngressBuilder<T>	withKafkaAddress(java.lang.String kafkaAddress)
KafkaIngressBuilder<T>	withProperties(java.util.Properties properties) A configuration property for the KafkaConsumer.
KafkaIngressBuilder<T>	withProperty(java.lang.String name, java.lang.String value) A configuration property for the KafkaProducer.
KafkaIngressBuilder<T>	withStartupPosition(KafkaIngressStartupPosition startupPosition) Configures the position that the ingress should start consuming from.
KafkaIngressBuilder<T>	withTopic(java.lang.String topic)

Methods inherited from class java.lang.Object

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

Method Detail

forIdentifier

public static <T> KafkaIngressBuilder<T> forIdentifier(IngressIdentifier<T> id)

Type Parameters:

T - The type consumed from Kafka.

Parameters:

id - A unique ingress identifier.

Returns:

A new KafkaIngressBuilder.

withConsumerGroupId

public KafkaIngressBuilder<T> withConsumerGroupId(java.lang.String consumerGroupId)

Parameters:

consumerGroupId - the consumer group id to use.

withKafkaAddress

public KafkaIngressBuilder<T> withKafkaAddress(java.lang.String kafkaAddress)

Parameters:

kafkaAddress - Comma separated addresses of the brokers.

withTopic

public KafkaIngressBuilder<T> withTopic(java.lang.String topic)

Parameters:

topic - The name of the topic that should be consumed.

addTopics

public KafkaIngressBuilder<T> addTopics(java.util.List<java.lang.String> topics)

Parameters:

topics - A list of topics that should be consumed.

withProperties

public KafkaIngressBuilder<T> withProperties(java.util.Properties properties)

A configuration property for the KafkaConsumer.

withProperty

public KafkaIngressBuilder<T> withProperty(java.lang.String name,
                                           java.lang.String value)

A configuration property for the KafkaProducer.

withDeserializer

public KafkaIngressBuilder<T> withDeserializer(java.lang.Class<? extends KafkaIngressDeserializer<T>> deserializerClass)

Parameters:

deserializerClass - The deserializer used to convert between Kafka's byte messages and java objects.

withAutoResetPosition

public KafkaIngressBuilder<T> withAutoResetPosition(KafkaIngressAutoResetPosition autoResetPosition)

Parameters:

autoResetPosition - the auto offset reset position to use, in case consumed offsets are invalid.

withStartupPosition

public KafkaIngressBuilder<T> withStartupPosition(KafkaIngressStartupPosition startupPosition)

Configures the position that the ingress should start consuming from. By default, the startup position is KafkaIngressStartupPosition.fromLatest().

Note that this configuration only affects the position when starting the application from a fresh start. When restoring the application from a savepoint, the ingress will always start consuming from the offsets persisted in the savepoint.

Parameters:

startupPosition - the position that the Kafka ingress should start consuming from.

See Also:

KafkaIngressStartupPosition

build

public KafkaIngressSpec<T> build()

Returns:

A new KafkaIngressSpec.