Package io.smallrye.reactive.messaging.kafka.api

Class OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>

java.lang.Object

io.smallrye.reactive.messaging.kafka.api.OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>

Type Parameters:

K - the Kafka record key type

Enclosing class:

OutgoingKafkaRecordMetadata<K>

public static class OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>
extends Object

Builder to create OutgoingKafkaRecordMetadata instances

Constructor Summary

Constructors

Constructor	Description
OutgoingKafkaRecordMetadataBuilder()

Method Summary

Modifier and Type	Method	Description
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	addHeaders(org.apache.kafka.common.header.internals.RecordHeader... headers)	Add headers for the Kafka record
OutgoingKafkaRecordMetadata<K>	build()	Create the OutgoingKafkaRecordMetadata instance based on the values set in this builder
protected org.apache.kafka.common.header.Headers	getHeaders()
protected int	getPartition()
protected K	getRecordKey()
protected Instant	getTimestamp()
protected String	getTopic()
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	withHeaders(List<org.apache.kafka.common.header.internals.RecordHeader> headers)	Specify the headers for the Kafka record
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	withHeaders(org.apache.kafka.common.header.Headers headers)	Specify headers for the Kafka record
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	withKey(K recordKey)	Set the Kafka record key
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	withPartition(int partition)	In most cases Kafka's partitioner should be used to chose the Kafka partition.
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	withTimestamp(Instant timestamp)	Specify the timestamp for the Kafka record
OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K>	withTopic(String topic)	By default the hardcoded topic in the configuration is used.

Methods inherited from class java.lang.Object

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

Constructor Details

OutgoingKafkaRecordMetadataBuilder

public OutgoingKafkaRecordMetadataBuilder()

Method Details

withTopic

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> withTopic(String topic)

By default the hardcoded topic in the configuration is used. If decisions need to be made dynamically about which topic to use, it may be specified here.

Parameters:

topic - the topic name

Returns:

this builder

withKey

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> withKey(K recordKey)

Set the Kafka record key

Parameters:

recordKey - the key

Returns:

this builder

withPartition

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> withPartition(int partition)

In most cases Kafka's partitioner should be used to chose the Kafka partition. Im cases where that is not suitable, it may be specified here.

Parameters:

partition - the partition to use

Returns:

this builder

withTimestamp

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> withTimestamp(Instant timestamp)

Specify the timestamp for the Kafka record

Parameters:

timestamp - the timestamp

Returns:

this builder

withHeaders

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> withHeaders(org.apache.kafka.common.header.Headers headers)

Specify headers for the Kafka record

Parameters:

headers - the headers

Returns:

this builder

addHeaders

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> addHeaders(org.apache.kafka.common.header.internals.RecordHeader... headers)

Add headers for the Kafka record

Parameters:

headers - the headers

Returns:

this builder

withHeaders

public OutgoingKafkaRecordMetadata.OutgoingKafkaRecordMetadataBuilder<K> withHeaders(List<org.apache.kafka.common.header.internals.RecordHeader> headers)

Specify the headers for the Kafka record

Parameters:

headers - the headers

Returns:

this builder

getTopic

protected String getTopic()

getRecordKey

protected K getRecordKey()

getPartition

protected int getPartition()

getTimestamp

protected Instant getTimestamp()

getHeaders

protected org.apache.kafka.common.header.Headers getHeaders()

build

public OutgoingKafkaRecordMetadata<K> build()

Create the OutgoingKafkaRecordMetadata instance based on the values set in this builder

Returns:

a new OutgoingKafkaRecordMetadata instance