org.apache.beam.sdk.io.kafka

Class KafkaIO.Write<K,V>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<KV<K,V>>,PDone>

org.apache.beam.sdk.io.kafka.KafkaIO.TypedWrite<K,V>

org.apache.beam.sdk.io.kafka.KafkaIO.Write<K,V>

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

KafkaIO

public static class KafkaIO.Write<K,V>
extends KafkaIO.TypedWrite<K,V>

A PTransform to write to a Kafka topic. See KafkaIO for more information on usage and configuration.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.io.kafka.KafkaIO.TypedWrite

keyCoder, producerConfig, producerFactoryFnOpt, topic, valueCoder

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name

Method Summary

Modifier and Type	Method and Description
KafkaIO.Write<K,V>	updateProducerProperties(Map<String,Object> configUpdates)
KafkaIO.Write<K,V>	withBootstrapServers(String bootstrapServers) Returns a new KafkaIO.Write transform with Kafka producer pointing to bootstrapServers.
<KeyT> KafkaIO.Write<KeyT,V>	withKeyCoder(Coder<KeyT> keyCoder) Returns a new KafkaIO.Write with Coder for serializing key (if any) to bytes.
KafkaIO.Write<K,V>	withTopic(String topic) Returns a new KafkaIO.Write transform that write to given topic.
<ValueT> KafkaIO.Write<K,ValueT>	withValueCoder(Coder<ValueT> valueCoder) Returns a new KafkaIO.Write with Coder for serializing value to bytes.

Methods inherited from class org.apache.beam.sdk.io.kafka.KafkaIO.TypedWrite

apply, validate, values, withProducerFactoryFn

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, populateDisplayData, toString

Methods inherited from class java.lang.Object

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

Method Detail

withBootstrapServers

public KafkaIO.Write<K,V> withBootstrapServers(String bootstrapServers)

Returns a new KafkaIO.Write transform with Kafka producer pointing to bootstrapServers.

withTopic

public KafkaIO.Write<K,V> withTopic(String topic)

Returns a new KafkaIO.Write transform that write to given topic.

withKeyCoder

public <KeyT> KafkaIO.Write<KeyT,V> withKeyCoder(Coder<KeyT> keyCoder)

Returns a new KafkaIO.Write with Coder for serializing key (if any) to bytes. A key is optional while writing to Kafka. Note when a key is set, its hash is used to determine partition in Kafka (see ProducerRecord for more details).

withValueCoder

public <ValueT> KafkaIO.Write<K,ValueT> withValueCoder(Coder<ValueT> valueCoder)

Returns a new KafkaIO.Write with Coder for serializing value to bytes.

updateProducerProperties

public KafkaIO.Write<K,V> updateProducerProperties(Map<String,Object> configUpdates)