PubsubMessage (Cloud Pub/Sub API v1 (Rev. 452) 1.25.0)

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 that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See Quotas and limits for more information about message limits.
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
  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()

Constructors
Constructor and Description
`PubsubMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PubsubMessage`	`clone()`
`byte[]`	`decodeData()` The message data field.
`PubsubMessage`	`encodeData(byte[] data)` The message data field.
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Attributes for this message.
`java.lang.String`	`getData()` The message data field.
`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)` Attributes for this message.
`PubsubMessage`	`setData(java.lang.String data)` The message data field.
`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

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
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
```
    Attributes for this message. If this field is empty, the message must contain non-empty data.
    
    Returns:
    
    value or null for none
  - setAttributes
```
public PubsubMessage setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Attributes for this message. If this field is empty, the message must contain non-empty data.
    
    Parameters:
    
    attributes - attributes or null for none
  - getData
```
public java.lang.String getData()
```
    The message data field. If this field is empty, the message must contain at least one attribute.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeData()
  - decodeData
```
public byte[] decodeData()
```
    The message data field. If this field is empty, the message must contain at least one attribute.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getData()
  - setData
```
public PubsubMessage setData(java.lang.String data)
```
    The message data field. If this field is empty, the message must contain at least one attribute.
    
    Parameters:
    
    data - data or null for none
    
    See Also:
    
    #encodeData()
  - encodeData
```
public PubsubMessage encodeData(byte[] data)
```
    The message data field. If this field is empty, the message must contain at least one attribute.
    
    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

Cloud Pub/Sub API v1 (revision 452)

Class PubsubMessage

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PubsubMessage

Method Detail

getAttributes

setAttributes

getData

decodeData

setData

encodeData

getMessageId

setMessageId

getPublishTime

setPublishTime

set

clone