com.google.cloud.pubsub

Class ReceivedMessage

java.lang.Object

com.google.cloud.pubsub.Message

com.google.cloud.pubsub.ReceivedMessage

All Implemented Interfaces:

Serializable

public final class ReceivedMessage
extends Message

A Google Cloud Pub/Sub received message. A received message has all the information in Message as well as the acknowledge id. The ack id can be used to acknowledge the received message.

ReceivedMessage also adds a layer of service-related functionality over Message that help manage received messages (see ack(), nack() and modifyAckDeadline(int, TimeUnit)).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReceivedMessage.Builder

Method Summary

Methods

Modifier and Type	Method and Description
void	ack() Acknowledges the current message.
Future<Void>	ackAsync() Sends a request to acknowledge the current message.
String	ackId() Returns the acknowledge id of the message.
boolean	equals(Object obj)
int	hashCode()
void	modifyAckDeadline(int deadline, TimeUnit unit) Modifies the acknowledge deadline of the current message.
Future<Void>	modifyAckDeadlineAsync(int deadline, TimeUnit unit) Sends a request to modify the acknowledge deadline of the given messages.
void	nack() "Nacks" the current message.
Future<Void>	nackAsync() Sends a request to "nack" the current message.
PubSub	pubsub() Returns the received message's PubSub object used to issue requests.
String	subscription() Returns the name of the subscription this message was received from.
ReceivedMessage.Builder	toBuilder() Returns a builder for the message object.

Methods inherited from class com.google.cloud.pubsub.Message

attributes, builder, builder, id, of, of, payload, payloadAsString, publishTime, toString

Methods inherited from class java.lang.Object

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

Method Detail

toBuilder

public ReceivedMessage.Builder toBuilder()

Description copied from class: Message

Returns a builder for the message object.

Overrides:

toBuilder in class Message

hashCode

public int hashCode()

Overrides:

hashCode in class Message

equals

public boolean equals(Object obj)

Overrides:

equals in class Message

pubsub

public PubSub pubsub()

Returns the received message's PubSub object used to issue requests.

subscription

public String subscription()

Returns the name of the subscription this message was received from.

ackId

public String ackId()

Returns the acknowledge id of the message. The ack id can be used to acknowledge the received message.

ack

public void ack()

Acknowledges the current message.

Throws:

PubSubException - upon failure, or if the subscription was not found

ackAsync

public Future<Void> ackAsync()

Sends a request to acknowledge the current message. The method returns a Future object that can be used to wait for the acknowledge operation to be completed.

Throws:

PubSubException - upon failure, or if the subscription was not found

nack

public void nack()

"Nacks" the current message. This method corresponds to calling modifyAckDeadline(int, TimeUnit) with a deadline of 0.

Throws:

PubSubException - upon failure, or if the subscription was not found

nackAsync

public Future<Void> nackAsync()

Sends a request to "nack" the current message. This method corresponds to calling modifyAckDeadlineAsync(int, TimeUnit) with a deadline of 0. The method returns a Future object that can be used to wait for the "nack" operation to be completed.

Throws:

PubSubException - upon failure, or if the subscription was not found

modifyAckDeadline

public void modifyAckDeadline(int deadline,
                     TimeUnit unit)

Modifies the acknowledge deadline of the current message. deadline must be >= 0 and is the new deadline with respect to the time the modify request was received by the Pub/Sub service. For example, if deadline is 10 and unit is TimeUnit.SECONDS, the new ack deadline will expire 10 seconds after the modify request was received by the service. Specifying 0 may be used to make the message available for another pull request (corresponds to calling nack().

Parameters:

deadline - the new deadline, relative to the time the modify request is received by the Pub/Sub service

unit - deadline time unit

Throws:

PubSubException - upon failure, or if the subscription was not found

modifyAckDeadlineAsync

public Future<Void> modifyAckDeadlineAsync(int deadline,
                                  TimeUnit unit)

Sends a request to modify the acknowledge deadline of the given messages. deadline must be >= 0 and is the new deadline with respect to the time the modify request was received by the Pub/Sub service. For example, if deadline is 10 and unit is TimeUnit.SECONDS, the new ack deadline will expire 10 seconds after the modify request was received by the service. Specifying 0 may be used to make the message available for another pull request (corresponds to calling nackAsync(). The method returns a Future object that can be used to wait for the modify operation to be completed.

Parameters:

deadline - the new deadline, relative to the time the modify request is received by the Pub/Sub service

unit - deadline time unit

Throws:

PubSubException - upon failure, or if the subscription was not found