Class MessageMetadata (1.12.8)

public abstract class MessageMetadata

Information about a message in Pub/Sub Lite. Can be encoded in the string returned by the Cloud Pub/Sub com.google.cloud.pubsub.v1.Publisher#publish api or the com.google.pubsub.v1.PubsubMessage#getMessageId field on received messages.

Inheritance

java.lang.Object > MessageMetadata

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

decode(String encoded)

public static MessageMetadata decode(String encoded)

Decode a MessageMetadata from the Cloud Pub/Sub ack id.

Parameter
Name	Description
`encoded`	`String`

Returns
Type	Description
`MessageMetadata`

Exceptions
Type	Description
`ApiException`

of(Partition partition, Offset offset)

public static MessageMetadata of(Partition partition, Offset offset)

Construct a MessageMetadata from a Partition and Offset.

Parameters
Name	Description
`partition`	`Partition`
`offset`	`Offset`

Returns
Type	Description
`MessageMetadata`

Constructors

MessageMetadata()

public MessageMetadata()

Methods

encode()

public String encode()

Encode a publish metadata as a Cloud Pub/Sub ack id.

Returns
Type	Description
`String`

offset()

public abstract Offset offset()

The offset a message was assigned.

If this MessageMetadata was returned for a publish result and publish idempotence was enabled, the offset may be -1 when the message was identified as a duplicate of an already successfully published message, but the server did not have sufficient information to return the message's offset at publish time. Messages received by subscribers will always have the correct offset.

Returns
Type	Description
`Offset`

partition()

public abstract Partition partition()

The partition a message was published to.

Returns
Type	Description
`Partition`