Class: Google::Cloud::PubSub::V1::ReceivedMessage

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

Overview

A message and its corresponding acknowledgment ID.

Instance Attribute Summary collapse

Instance Attribute Details

#ack_id ⇒ ::String

Returns Optional. This ID can be used to acknowledge the received message.

Returns:

  • (::String) —

    Optional. This ID can be used to acknowledge the received message.



1205
1206
1207
1208
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1205

class ReceivedMessage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#delivery_attempt ⇒ ::Integer

Returns Optional. The approximate number of times that 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) —

    Optional. The approximate number of times that 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.



1205
1206
1207
1208
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1205

class ReceivedMessage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#message ⇒ ::Google::Cloud::PubSub::V1::PubsubMessage

Returns Optional. The message.

Returns:



1205
1206
1207
1208
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1205

class ReceivedMessage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end