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.Write<K,V>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

KafkaIO

public abstract static class KafkaIO.Write<K,V>
extends PTransform<PCollection<KV<K,V>>,PDone>

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.transforms.PTransform

name

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<KV<K,V>> input) Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
KafkaIO.Write<K,V>	updateProducerProperties(java.util.Map<java.lang.String,java.lang.Object> configUpdates) Adds the given producer properties, overriding old values of properties with the same key.
PTransform<PCollection<V>,PDone>	values() Writes just the values to Kafka.
KafkaIO.Write<K,V>	withBootstrapServers(java.lang.String bootstrapServers) Returns a new KafkaIO.Write transform with Kafka producer pointing to bootstrapServers.
KafkaIO.Write<K,V>	withKeySerializer(java.lang.Class<? extends org.apache.kafka.common.serialization.Serializer<K>> keySerializer) Sets a Serializer for serializing key (if any) to bytes.
KafkaIO.Write<K,V>	withProducerFactoryFn(SerializableFunction<java.util.Map<java.lang.String,java.lang.Object>,org.apache.kafka.clients.producer.Producer<K,V>> producerFactoryFn) Sets a custom function to create Kafka producer.
KafkaIO.Write<K,V>	withTopic(java.lang.String topic) Sets the Kafka topic to write to.
KafkaIO.Write<K,V>	withValueSerializer(java.lang.Class<? extends org.apache.kafka.common.serialization.Serializer<V>> valueSerializer) Sets a Serializer for serializing value to bytes.

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

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

withBootstrapServers

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

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

withTopic

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

Sets the Kafka topic to write to.

withKeySerializer

public KafkaIO.Write<K,V> withKeySerializer(java.lang.Class<? extends org.apache.kafka.common.serialization.Serializer<K>> keySerializer)

Sets a Serializer 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).

withValueSerializer

public KafkaIO.Write<K,V> withValueSerializer(java.lang.Class<? extends org.apache.kafka.common.serialization.Serializer<V>> valueSerializer)

Sets a Serializer for serializing value to bytes.

updateProducerProperties

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

Adds the given producer properties, overriding old values of properties with the same key.

withProducerFactoryFn

public KafkaIO.Write<K,V> withProducerFactoryFn(SerializableFunction<java.util.Map<java.lang.String,java.lang.Object>,org.apache.kafka.clients.producer.Producer<K,V>> producerFactoryFn)

Sets a custom function to create Kafka producer. Primarily used for tests. Default is KafkaProducer

values

public PTransform<PCollection<V>,PDone> values()

Writes just the values to Kafka. This is useful for writing collections of values rather thank KVs.

expand

public PDone expand(PCollection<KV<K,V>> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<KV<K,V>>,PDone>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<KV<K,V>>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData