co.cask.cdap.messaging.client

Class StoreRequestBuilder

java.lang.Object

co.cask.cdap.messaging.client.StoreRequestBuilder

public final class StoreRequestBuilder
extends Object

A builder to create StoreRequest instances. This is mainly used on the client side.

Method Summary

Methods

Modifier and Type	Method and Description
StoreRequestBuilder	addPayloads(byte[]... payloads) Adds a list of byte arrays as the payloads of the request.
StoreRequestBuilder	addPayloads(Iterator<byte[]> payloads) Adds a list of byte arrays as the payloads of the request.
StoreRequestBuilder	addPayloads(String... payloads) Adds a list of Strings as the payloads of the request.
StoreRequest	build() Creates a StoreRequest based on the settings in this builder.
boolean	hasPayload() Returns true if there is some payload in this builder.
static StoreRequestBuilder	of(co.cask.cdap.proto.id.TopicId topicId) Creates a new StoreRequestBuilder instance.
StoreRequestBuilder	setTransaction(Long txWritePointer) Sets the transaction write pointer to be used for the request.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static StoreRequestBuilder of(co.cask.cdap.proto.id.TopicId topicId)

Creates a new StoreRequestBuilder instance.

Parameters:

topicId - the topic that the store action will happen.

addPayloads

public StoreRequestBuilder addPayloads(byte[]... payloads)

Adds a list of byte arrays as the payloads of the request.

addPayloads

public StoreRequestBuilder addPayloads(String... payloads)

Adds a list of Strings as the payloads of the request. The Strings will be converted to byte arrays using UTF-8 encoding.

addPayloads

public StoreRequestBuilder addPayloads(Iterator<byte[]> payloads)

Adds a list of byte arrays as the payloads of the request.

setTransaction

public StoreRequestBuilder setTransaction(@Nullable
                                 Long txWritePointer)

Sets the transaction write pointer to be used for the request.

Parameters:

txWritePointer - the transaction write pointer if want to publish transactionally, or null for non-transactional publish.

hasPayload

public boolean hasPayload()

Returns true if there is some payload in this builder.

build

public StoreRequest build()

Creates a StoreRequest based on the settings in this builder.