Class: Google::Cloud::Pubsub::ReceivedMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/received_message.rb

Overview

# ReceivedMessage

Represents a Pub/Sub Message that can be acknowledged or delayed.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
received_message = sub.pull.first
if received_message
  puts received_message.message.data
  received_message.acknowledge!
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ReceivedMessage

Returns a new instance of ReceivedMessage.



51
52
53
54
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 51

def initialize
  @subscription = nil
  @grpc = Google::Pubsub::V1::ReceivedMessage.new
end

Instance Attribute Details

#grpc ⇒ Object 



47
48
49
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 47

def grpc
  @grpc
end

#subscription ⇒ Object 



43
44
45
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 43

def subscription
  @subscription
end

Class Method Details

.from_grpc(grpc, subscription) ⇒ Object

Google::Pubsub::V1::ReceivedMessage object.



145
146
147
148
149
150
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 145

def self.from_grpc grpc, subscription
  new.tap do |rm|
    rm.grpc         = grpc
    rm.subscription = subscription
  end
end

Instance Method Details

#ack_id ⇒ Object

The acknowledgment ID for the message.



58
59
60
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 58

def ack_id
  @grpc.ack_id
end

#acknowledge! ⇒ Object Also known as: ack!

Acknowledges receipt of the message.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
received_message = sub.pull.first
if received_message
  puts received_message.message.data
  received_message.acknowledge!
end


105
106
107
108
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 105

def acknowledge!
  ensure_subscription!
  subscription.acknowledge ack_id
end

#attributes ⇒ Object

The received message’s attributes.



77
78
79
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 77

def attributes
  message.attributes
end

#data ⇒ Object

The received message’s data.



71
72
73
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 71

def data
  message.data
end

#delay!(new_deadline) ⇒ Object

Modifies the acknowledge deadline for the message.

This indicates that more time is needed to process the message, or to make the message available for redelivery.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
received_message = sub.pull.first
if received_message
  puts received_message.message.data
  # Delay for 2 minutes
  received_message.delay! 120
end

Parameters:

  • new_deadline (Integer) —

    The new ack deadline in seconds from the time this request is sent to the Pub/Sub system. Must be >= 0. For example, if the value is ‘10`, the new ack deadline will expire 10 seconds after the call is made. Specifying `0` may immediately make the message available for another pull request.



137
138
139
140
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 137

def delay! new_deadline
  ensure_subscription!
  subscription.delay new_deadline, ack_id
end

#message ⇒ Object Also known as: msg

The received message.



64
65
66
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 64

def message
  Message.from_grpc @grpc.message
end

#message_id ⇒ Object Also known as: msg_id

The ID of the received message, assigned by the server at publication time. Guaranteed to be unique within the topic.



84
85
86
 
# File 'lib/google/cloud/pubsub/received_message.rb', line 84

def message_id
  message.message_id
end