org.apache.pulsar.client.impl

Class MessageBuilderImpl<T>

java.lang.Object

org.apache.pulsar.client.impl.MessageBuilderImpl<T>

All Implemented Interfaces:

MessageBuilder<T>

public class MessageBuilderImpl<T>
extends Object
implements MessageBuilder<T>

Constructor Summary

Constructors

Constructor and Description
MessageBuilderImpl(Schema<T> schema)

Method Summary

Modifier and Type	Method and Description
Message<T>	build() Finalize the immutable message
MessageBuilder<T>	disableReplication() Disable replication for this message.
MessageBuilder<T>	setContent(byte[] data) Set the content of the message
MessageBuilder<T>	setContent(byte[] data, int offet, int length) Set the content of the message
MessageBuilder<T>	setContent(ByteBuffer buf) Set the content of the message
MessageBuilder<T>	setEventTime(long timestamp) Set the event time for a given message.
MessageBuilder<T>	setKey(String key) Sets the key of the message for routing policy
MessageBuilder<T>	setProperties(Map<String,String> properties) Add all the properties in the provided map
MessageBuilder<T>	setProperty(String name, String value) Sets a new property on a message.
MessageBuilder<T>	setReplicationClusters(List<String> clusters) Override the replication clusters for this message.
MessageBuilder<T>	setSequenceId(long sequenceId) Specify a custom sequence id for the message being published.
MessageBuilder<T>	setValue(T value) Set a domain object on the message

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.MessageBuilder

create, create

Constructor Detail

MessageBuilderImpl

public MessageBuilderImpl(Schema<T> schema)

Method Detail

build

public Message<T> build()

Description copied from interface: MessageBuilder

Finalize the immutable message

Specified by:

build in interface MessageBuilder<T>

Returns:

a Message ready to be sent through a Producer

setValue

public MessageBuilder<T> setValue(T value)

Description copied from interface: MessageBuilder

Set a domain object on the message

Specified by:

setValue in interface MessageBuilder<T>

Parameters:

value - the domain object

setContent

public MessageBuilder<T> setContent(byte[] data)

Description copied from interface: MessageBuilder

Set the content of the message

Specified by:

setContent in interface MessageBuilder<T>

Parameters:

data - array containing the payload

setContent

public MessageBuilder<T> setContent(byte[] data,
                                    int offet,
                                    int length)

Description copied from interface: MessageBuilder

Set the content of the message

Specified by:

setContent in interface MessageBuilder<T>

Parameters:

data - array containing the payload

offet - offset into the data array

length - length of the payload starting from the above offset

setContent

public MessageBuilder<T> setContent(ByteBuffer buf)

Description copied from interface: MessageBuilder

Set the content of the message

Specified by:

setContent in interface MessageBuilder<T>

Parameters:

buf - a ByteBuffer with the payload of the message

setProperties

public MessageBuilder<T> setProperties(Map<String,String> properties)

Description copied from interface: MessageBuilder

Add all the properties in the provided map

Specified by:

setProperties in interface MessageBuilder<T>

setProperty

public MessageBuilder<T> setProperty(String name,
                                     String value)

Description copied from interface: MessageBuilder

Sets a new property on a message.

Specified by:

setProperty in interface MessageBuilder<T>

Parameters:

name - the name of the property

value - the associated value

setKey

public MessageBuilder<T> setKey(String key)

Description copied from interface: MessageBuilder

Sets the key of the message for routing policy

Specified by:

setKey in interface MessageBuilder<T>

setEventTime

public MessageBuilder<T> setEventTime(long timestamp)

Description copied from interface: MessageBuilder

Set the event time for a given message.

Applications can retrieve the event time by calling Message.getEventTime().

Note: currently pulsar doesn't support event-time based index. so the subscribers can't seek the messages by event time.

Specified by:

setEventTime in interface MessageBuilder<T>

setSequenceId

public MessageBuilder<T> setSequenceId(long sequenceId)

Description copied from interface: MessageBuilder

Specify a custom sequence id for the message being published.

The sequence id can be used for deduplication purposes and it needs to follow these rules:

1. sequenceId >= 0
2. Sequence id for a message needs to be greater than sequence id for earlier messages: sequenceId(N+1) > sequenceId(N)
3. It's not necessary for sequence ids to be consecutive. There can be holes between messages. Eg. the sequenceId could represent an offset or a cumulative size.

Specified by:

setSequenceId in interface MessageBuilder<T>

Parameters:

sequenceId - the sequence id to assign to the current message

setReplicationClusters

public MessageBuilder<T> setReplicationClusters(List<String> clusters)

Description copied from interface: MessageBuilder

Override the replication clusters for this message.

Specified by:

setReplicationClusters in interface MessageBuilder<T>

disableReplication

public MessageBuilder<T> disableReplication()

Description copied from interface: MessageBuilder

Disable replication for this message.

Specified by:

disableReplication in interface MessageBuilder<T>