Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::ReceivedMessage (v0.17.4)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::ReceivedMessage.

A message and its corresponding acknowledgment ID.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#ack_id

def ack_id() -> ::String
Returns
  • (::String) — This ID can be used to acknowledge the received message.

#ack_id=

def ack_id=(value) -> ::String
Parameter
  • value (::String) — This ID can be used to acknowledge the received message.
Returns
  • (::String) — This ID can be used to acknowledge the received message.

#delivery_attempt

def delivery_attempt() -> ::Integer
Returns
  • (::Integer) — 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.

#delivery_attempt=

def delivery_attempt=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#message

def message() -> ::Google::Cloud::PubSub::V1::PubsubMessage
Returns

#message=

def message=(value) -> ::Google::Cloud::PubSub::V1::PubsubMessage
Parameter
Returns