com.google.cloud.pubsub

Class Message

java.lang.Object

com.google.cloud.pubsub.Message

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ReceivedMessage

public class Message
extends Object
implements Serializable

A Google Cloud Pub/Sub message. A message is the combination of data and (optional) attributes that a publisher sends to a topic and is eventually delivered to subscribers.

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.

To be published, a message must have a non-empty payload, or at least one attribute.

See Also:

Pub/Sub Data Model, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder Builder for Message objects.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	attributes() Returns the message attributes.
static Message.Builder	builder(ByteArray payload) Creates a builder for Message objects given the payload as a ByteArray.
static Message.Builder	builder(String payload) Creates a builder for Message objects given the payload as a string.
boolean	equals(Object obj)
int	hashCode()
String	id() Returns the id of this message, set by the server when the message is published.
static Message	of(ByteArray payload) Creates a Message object given the payload as a ByteArray.
static Message	of(String payload) Creates a Message object given the payload as a string.
ByteArray	payload() Returns the message payload.
String	payloadAsString() Returns the message payload as a string, decoded using UTF-8.
Long	publishTime() Returns the time in milliseconds at which the message was published.
Message.Builder	toBuilder() Returns a builder for the message object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

publishTime

public Long publishTime()

Returns the time in milliseconds at which the message was published. This value is set by the server when it receives the publish call. If not set, this method returns null.

attributes

public Map<String,String> attributes()

Returns the message attributes. 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.

id

public String id()

Returns the id of this message, set by the server when the message is published. The id is guaranteed to be unique within the topic. This value may be read by a subscriber that receives a Pub/Sub message via a pull call or a push delivery. If not set, this method returns null.

payloadAsString

public String payloadAsString()

Returns the message payload as a string, decoded using UTF-8.

payload

public ByteArray payload()

Returns the message payload.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public Message.Builder toBuilder()

Returns a builder for the message object.

of

public static Message of(String payload)

Creates a Message object given the payload as a string. The string is enconded using UTF-8.

of

public static Message of(ByteArray payload)

Creates a Message object given the payload as a ByteArray. To be published a message must have a non-empty payload.

builder

public static Message.Builder builder(String payload)

Creates a builder for Message objects given the payload as a string. The string is enconded using UTF-8. To be published a message must have a non-empty payload.

builder

public static Message.Builder builder(ByteArray payload)

Creates a builder for Message objects given the payload as a ByteArray. To be published a message must have a non-empty payload, or at least one attribute.