com.google.cloud.pubsub

Class ReceivedMessage.Builder

java.lang.Object

com.google.cloud.pubsub.Message.Builder

com.google.cloud.pubsub.ReceivedMessage.Builder

Enclosing class:

ReceivedMessage

public static final class ReceivedMessage.Builder
extends Message.Builder

Method Summary

Methods

Modifier and Type	Method and Description
ReceivedMessage.Builder	addAttribute(String name, String value) Adds a new attribute to the message attributes.
ReceivedMessage.Builder	attributes(Map<String,String> attributes) Sets the message attributes to the provided map.
ReceivedMessage	build() Creates a message object.
ReceivedMessage.Builder	clearAttributes() Clears all message attributes.
ReceivedMessage.Builder	payload(ByteArray payload) Sets the message payload to the provided ByteArray.
ReceivedMessage.Builder	payload(String payload) Sets the message payload to the provided string.
ReceivedMessage.Builder	removeAttribute(String name) Removes an attribute give its name from the message attributes.

Methods inherited from class java.lang.Object

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

Method Detail

payload

public ReceivedMessage.Builder payload(String payload)

Description copied from class: Message.Builder

Sets the message payload to the provided string. The string is enconded UTF-8.

Specified by:

payload in class Message.Builder

payload

public ReceivedMessage.Builder payload(ByteArray payload)

Description copied from class: Message.Builder

Sets the message payload to the provided ByteArray.

Specified by:

payload in class Message.Builder

attributes

public ReceivedMessage.Builder attributes(Map<String,String> attributes)

Description copied from class: Message.Builder

Sets the message attributes to the provided map. Message attributes are key-value pairs that a publisher can define for a message. For example, a key iana.org/language_tag and value en could be added to messages to mark them as readable by an English-speaking subscriber.

Specified by:

attributes in class Message.Builder

addAttribute

public ReceivedMessage.Builder addAttribute(String name,
                                   String value)

Description copied from class: Message.Builder

Adds a new attribute to the message attributes. If an attribute with name name was already set, its value is updated.

Specified by:

addAttribute in class Message.Builder

removeAttribute

public ReceivedMessage.Builder removeAttribute(String name)

Description copied from class: Message.Builder

Removes an attribute give its name from the message attributes.

Specified by:

removeAttribute in class Message.Builder

clearAttributes

public ReceivedMessage.Builder clearAttributes()

Description copied from class: Message.Builder

Clears all message attributes.

Specified by:

clearAttributes in class Message.Builder

build

public ReceivedMessage build()

Description copied from class: Message.Builder

Creates a message object.

Specified by:

build in class Message.Builder