Interface ReceivedMessageOrBuilder (1.123.18)

public interface ReceivedMessageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAckId()

public abstract String getAckId()

This ID can be used to acknowledge the received message.

string ack_id = 1;

Returns
TypeDescription
String

The ackId.

getAckIdBytes()

public abstract ByteString getAckIdBytes()

This ID can be used to acknowledge the received message.

string ack_id = 1;

Returns
TypeDescription
ByteString

The bytes for ackId.

getDeliveryAttempt()

public abstract int getDeliveryAttempt()

The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.

More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.

A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.

Upon the first delivery of a given message, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate.

If a DeadLetterPolicy is not set on the subscription, this will be 0.

int32 delivery_attempt = 3;

Returns
TypeDescription
int

The deliveryAttempt.

getMessage()

public abstract PubsubMessage getMessage()

The message.

.google.pubsub.v1.PubsubMessage message = 2;

Returns
TypeDescription
PubsubMessage

The message.

getMessageOrBuilder()

public abstract PubsubMessageOrBuilder getMessageOrBuilder()

The message.

.google.pubsub.v1.PubsubMessage message = 2;

Returns
TypeDescription
PubsubMessageOrBuilder

hasMessage()

public abstract boolean hasMessage()

The message.

.google.pubsub.v1.PubsubMessage message = 2;

Returns
TypeDescription
boolean

Whether the message field is set.