com.google.cloud.pubsub

Class Message.Builder

java.lang.Object

com.google.cloud.pubsub.Message.Builder

Direct Known Subclasses:

ReceivedMessage.Builder

Enclosing class:

Message

public abstract static class Message.Builder
extends Object

Builder for Message objects.

Constructor Summary

Constructors

Constructor and Description
Message.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Message.Builder	addAttribute(String name, String value) Adds a new attribute to the message attributes.
abstract Message.Builder	attributes(Map<String,String> attributes) Sets the message attributes to the provided map.
abstract Message	build() Creates a message object.
abstract Message.Builder	clearAttributes() Clears all message attributes.
abstract Message.Builder	payload(ByteArray payload) Sets the message payload to the provided ByteArray.
abstract Message.Builder	payload(String payload) Sets the message payload to the provided string.
abstract Message.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

Constructor Detail

Message.Builder

public Message.Builder()

Method Detail

payload

public abstract Message.Builder payload(String payload)

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

payload

public abstract Message.Builder payload(ByteArray payload)

Sets the message payload to the provided ByteArray.

attributes

public abstract Message.Builder attributes(Map<String,String> attributes)

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.

addAttribute

public abstract Message.Builder addAttribute(String name,
                           String value)

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

removeAttribute

public abstract Message.Builder removeAttribute(String name)

Removes an attribute give its name from the message attributes.

clearAttributes

public abstract Message.Builder clearAttributes()

Clears all message attributes.

build

public abstract Message build()

Creates a message object.