com.google.api.services.pubsub.model

Class PubsubMessage

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class PubsubMessage
extends com.google.api.client.json.GenericJson

A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

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 Google 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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PubsubMessage()

Method Summary

Methods

Modifier and Type	Method and Description
PubsubMessage	clone()
byte[]	decodeData() The message payload.
PubsubMessage	encodeData(byte[] data) The message payload.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Optional attributes for this message.
java.lang.String	getData() The message payload.
java.lang.String	getMessageId() ID of this message, assigned by the server when the message is published.
java.lang.String	getPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
PubsubMessage	set(java.lang.String fieldName, java.lang.Object value)
PubsubMessage	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) Optional attributes for this message.
PubsubMessage	setData(java.lang.String data) The message payload.
PubsubMessage	setMessageId(java.lang.String messageId) ID of this message, assigned by the server when the message is published.
PubsubMessage	setPublishTime(java.lang.String publishTime) The time at which the message was published, populated by the server when it receives the `Publish` call.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubMessage

public PubsubMessage()

Method Detail

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Optional attributes for this message.

Returns:

value or null for none

setAttributes

public PubsubMessage setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Optional attributes for this message.

Parameters:

attributes - attributes or null for none

getData

public java.lang.String getData()

The message payload. For JSON requests, the value of this field must be base64-encoded.

Returns:

value or null for none

See Also:

decodeData()

decodeData

public byte[] decodeData()

The message payload. For JSON requests, the value of this field must be base64-encoded.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getData()

setData

public PubsubMessage setData(java.lang.String data)

The message payload. For JSON requests, the value of this field must be base64-encoded.

Parameters:

data - data or null for none

See Also:

#encodeData()

encodeData

public PubsubMessage encodeData(byte[] data)

The message payload. For JSON requests, the value of this field must be base64-encoded.

Since:

1.14

See Also:

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

getMessageId

public java.lang.String getMessageId()

ID of this message, assigned by the server when the message is published. 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 the publisher in a `Publish` call.

Returns:

value or null for none

setMessageId

public PubsubMessage setMessageId(java.lang.String messageId)

ID of this message, assigned by the server when the message is published. 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 the publisher in a `Publish` call.

Parameters:

messageId - messageId or null for none

getPublishTime

public java.lang.String getPublishTime()

The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.

Returns:

value or null for none

setPublishTime

public PubsubMessage setPublishTime(java.lang.String publishTime)

The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.

Parameters:

publishTime - publishTime or null for none

set

public PubsubMessage set(java.lang.String fieldName,
                java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PubsubMessage clone()

Overrides:

clone in class com.google.api.client.json.GenericJson