Package org.apache.beam.sdk.io.gcp.pubsub

Class PubsubMessage

java.lang.Object

org.apache.beam.sdk.io.gcp.pubsub.PubsubMessage

public class PubsubMessage
extends Object

Class representing a Pub/Sub message. Each message contains a single message payload, a map of attached attributes, a message id and an ordering key.

Constructor Summary

Constructors

Constructor	Description
PubsubMessage(byte[] payload, @Nullable Map<String,String> attributes)
PubsubMessage(byte[] payload, @Nullable Map<String,String> attributes, @Nullable String messageId)
PubsubMessage(byte[] payload, @Nullable Map<String,String> attributes, @Nullable String messageId, @Nullable String orderingKey)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
@Nullable String	getAttribute(String attribute)	Returns the given attribute value.
@Nullable Map<String,String>	getAttributeMap()	Returns the full map of attributes.
@Nullable String	getMessageId()	Returns the messageId of the message populated by Cloud Pub/Sub.
@Nullable String	getOrderingKey()	Returns the ordering key of the message.
byte[]	getPayload()	Returns the main PubSub message.
@Nullable String	getTopic()
int	hashCode()
String	toString()
PubsubMessage	withOrderingKey(@Nullable String orderingKey)
PubsubMessage	withTopic(String topic)

Methods inherited from class java.lang.Object

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

Constructor Details

PubsubMessage

public PubsubMessage(byte[] payload,
 @Nullable Map<String,String> attributes)

PubsubMessage

public PubsubMessage(byte[] payload,
 @Nullable Map<String,String> attributes,
 @Nullable String messageId)

PubsubMessage

public PubsubMessage(byte[] payload,
 @Nullable Map<String,String> attributes,
 @Nullable String messageId,
 @Nullable String orderingKey)

Method Details

withTopic

public PubsubMessage withTopic(String topic)

getTopic

public @Nullable String getTopic()

getPayload

public byte[] getPayload()

Returns the main PubSub message.

getAttribute

public @Nullable String getAttribute(String attribute)

Returns the given attribute value. If not such attribute exists, returns null.

getAttributeMap

public @Nullable Map<String,String> getAttributeMap()

Returns the full map of attributes. This is an unmodifiable map.

getMessageId

public @Nullable String getMessageId()

Returns the messageId of the message populated by Cloud Pub/Sub.

withOrderingKey

public PubsubMessage withOrderingKey(@Nullable String orderingKey)

getOrderingKey

public @Nullable String getOrderingKey()

Returns the ordering key of the message.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object