Package com.google.cloud.pubsublite

Class MessageMetadata

java.lang.Object
com.google.cloud.pubsublite.MessageMetadata
public abstract class MessageMetadata extends Object
Information about a message in Pub/Sub Lite. Can be encoded in the string returned by the Cloud Pub/Sub Publisher.publish(com.google.pubsub.v1.PubsubMessage) api or the PubsubMessage.getMessageId() field on received messages.

  • Constructor Details

    • MessageMetadata

      public MessageMetadata()

  • Method Details

    • partition

      public abstract Partition partition()
      The partition a message was published to.

    • 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.

    • of

      public static MessageMetadata of(Partition partition, Offset offset)
      Construct a MessageMetadata from a Partition and Offset.

    • decode

      public static MessageMetadata decode(String encoded) throws com.google.api.gax.rpc.ApiException
      Decode a MessageMetadata from the Cloud Pub/Sub ack id.
      Throws:
      com.google.api.gax.rpc.ApiException

    • encode

      public String encode()
      Encode a publish metadata as a Cloud Pub/Sub ack id.