org.apache.flink.connector.pulsar.sink.writer.message

Class PulsarMessageBuilder<T>

java.lang.Object

org.apache.flink.connector.pulsar.sink.writer.message.PulsarMessageBuilder<T>

@PublicEvolving
public class PulsarMessageBuilder<T>
extends Object

TypedMessageBuilder wrapper for providing the required method for end-users.

Constructor Summary

Constructors

Constructor and Description
PulsarMessageBuilder()

Method Summary

Modifier and Type	Method and Description
PulsarMessage<T>	build()
PulsarMessageBuilder<T>	disableReplication() Method wrapper of TypedMessageBuilder.disableReplication().
PulsarMessageBuilder<T>	eventTime(long eventTime) Method wrapper of TypedMessageBuilder.eventTime(long).
PulsarMessageBuilder<T>	key(String key) Property TypedMessageBuilder.key(String).
PulsarMessageBuilder<T>	orderingKey(byte[] orderingKey) Method wrapper of TypedMessageBuilder.orderingKey(byte[]).
PulsarMessageBuilder<T>	properties(Map<String,String> properties) Method wrapper of TypedMessageBuilder.properties(Map).
PulsarMessageBuilder<T>	property(String key, String value) Method wrapper of TypedMessageBuilder.property(String, String).
PulsarMessageBuilder<T>	replicationClusters(List<String> replicationClusters) Method wrapper of TypedMessageBuilder.replicationClusters(List).
PulsarMessageBuilder<T>	sequenceId(long sequenceId) Method wrapper of TypedMessageBuilder.sequenceId(long).
PulsarMessageBuilder<T>	value(org.apache.pulsar.client.api.Schema<T> schema, T value) Method wrapper of TypedMessageBuilder.value(Object).

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsarMessageBuilder

public PulsarMessageBuilder()

Method Detail

orderingKey

public PulsarMessageBuilder<T> orderingKey(byte[] orderingKey)

Method wrapper of TypedMessageBuilder.orderingKey(byte[]).

key

public PulsarMessageBuilder<T> key(String key)

Property TypedMessageBuilder.key(String). This property would also be used in KeyHashTopicRouter.

eventTime

public PulsarMessageBuilder<T> eventTime(long eventTime)

Method wrapper of TypedMessageBuilder.eventTime(long).

value

public PulsarMessageBuilder<T> value(org.apache.pulsar.client.api.Schema<T> schema,
                                     T value)

Method wrapper of TypedMessageBuilder.value(Object). You can pass any schema for validating it on Pulsar. This is called schema evolution. But the topic on Pulsar should bind to a fixed Schema. You can't have multiple schemas on the same topic unless it's compatible with each other.

Parameters:

value - The value could be null, which is called tombstones message in Pulsar. (It will be skipped and considered deleted.)

property

public PulsarMessageBuilder<T> property(String key,
                                        String value)

Method wrapper of TypedMessageBuilder.property(String, String).

properties

public PulsarMessageBuilder<T> properties(Map<String,String> properties)

Method wrapper of TypedMessageBuilder.properties(Map).

sequenceId

public PulsarMessageBuilder<T> sequenceId(long sequenceId)

Method wrapper of TypedMessageBuilder.sequenceId(long).

replicationClusters

public PulsarMessageBuilder<T> replicationClusters(List<String> replicationClusters)

Method wrapper of TypedMessageBuilder.replicationClusters(List).

disableReplication

public PulsarMessageBuilder<T> disableReplication()

Method wrapper of TypedMessageBuilder.disableReplication().

build

public PulsarMessage<T> build()