com.google.api.services.pubsub.model

Class PubsubMessage

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pubsub.model.PubsubMessage

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PubsubMessage
extends GenericJson

A message data and its labels.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PubsubMessage()

Method Summary

Modifier and Type	Method and Description
PubsubMessage	clone()
byte[]	decodeData() The message payload.
PubsubMessage	encodeData(byte[] data) The message payload.
String	getData() The message payload.
List<Label>	getLabel() Optional list of labels for this message.
String	getMessageId() ID of this message assigned by the server at publication time.
Long	getPublishTime() The time at which the message was published.
PubsubMessage	set(String fieldName, Object value)
PubsubMessage	setData(String data) The message payload.
PubsubMessage	setLabel(List<Label> label) Optional list of labels for this message.
PubsubMessage	setMessageId(String messageId) ID of this message assigned by the server at publication time.
PubsubMessage	setPublishTime(Long publishTime) The time at which the message was published.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PubsubMessage

public PubsubMessage()

Method Detail

getData

public String getData()

The message payload.

Returns:

value or null for none

See Also:

decodeData()

decodeData

public byte[] decodeData()

The message payload.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getData()

setData

public PubsubMessage setData(String data)

The message payload.

Parameters:

data - data or null for none

See Also:

#encodeData()

encodeData

public PubsubMessage encodeData(byte[] data)

The message payload.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getLabel

public List<Label> getLabel()

Optional list of labels for this message. Keys in this collection must be unique.

Returns:

value or null for none

setLabel

public PubsubMessage setLabel(List<Label> label)

Optional list of labels for this message. Keys in this collection must be unique.

Parameters:

label - label or null for none

getMessageId

public String getMessageId()

ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.

Returns:

value or null for none

setMessageId

public PubsubMessage setMessageId(String messageId)

ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.

Parameters:

messageId - messageId or null for none

getPublishTime

public Long getPublishTime()

The time at which the message was published. The time is milliseconds since the UNIX epoch.

Returns:

value or null for none

setPublishTime

public PubsubMessage setPublishTime(Long publishTime)

The time at which the message was published. The time is milliseconds since the UNIX epoch.

Parameters:

publishTime - publishTime or null for none

set

public PubsubMessage set(String fieldName,
                         Object value)

Overrides:

set in class GenericJson

clone

public PubsubMessage clone()

Overrides:

clone in class GenericJson