You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::SQS::ReceivedMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/aws/sqs/received_message.rb

Overview

Represents a message received from an Amazon SQS Queue.

Constant Summary

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#body ⇒ String (readonly)

Returns The message's contents.

Returns:

  • (String) —

    The message's contents.



34
35
36
 
# File 'lib/aws/sqs/received_message.rb', line 34

def body
  @body
end

#handle ⇒ String (readonly)

Returns A string associated with this specific instance of receiving the message.

Returns:

  • (String) —

    A string associated with this specific instance of receiving the message.



31
32
33
 
# File 'lib/aws/sqs/received_message.rb', line 31

def handle
  @handle
end

#id ⇒ String (readonly)

Returns The ID of the message.

Returns:

  • (String) —

    The ID of the message.



27
28
29
 
# File 'lib/aws/sqs/received_message.rb', line 27

def id
  @id
end

#md5 ⇒ String (readonly)

Returns An MD5 digest of the message body.

Returns:

  • (String) —

    An MD5 digest of the message body.



37
38
39
 
# File 'lib/aws/sqs/received_message.rb', line 37

def md5
  @md5
end

#message_attributes ⇒ String (readonly)

Returns The message attributes attached to the message.

Returns:

  • (String) —

    The message attributes attached to the message.



46
47
48
 
# File 'lib/aws/sqs/received_message.rb', line 46

def message_attributes
  @message_attributes
end

#queue ⇒ Queue (readonly)

Returns The queue from which this message was received.

Returns:

  • (Queue) —

    The queue from which this message was received.



24
25
26
 
# File 'lib/aws/sqs/received_message.rb', line 24

def queue
  @queue
end

#request_id ⇒ String (readonly)

Returns The request ID.

Returns:

  • (String) —

    The request ID.



40
41
42
 
# File 'lib/aws/sqs/received_message.rb', line 40

def request_id
  @request_id
end

Instance Method Details

#approximate_first_receive_timestamp ⇒ Time Also known as: first_received_at

Returns The time when the message was first received.

Returns:

  • (Time) —

    The time when the message was first received.



180
181
182
183
184
 
# File 'lib/aws/sqs/received_message.rb', line 180

def approximate_first_receive_timestamp
  @received_at ||=
    (timestamp = attributes["ApproximateFirstReceiveTimestamp"] and
     Time.at(timestamp.to_i / 1000.0)) || nil
end

#approximate_receive_count ⇒ Integer Also known as: receive_count

Returns The number of times a message has been received but not deleted.

Returns:

  • (Integer) —

    The number of times a message has been received but not deleted.



173
174
175
176
 
# File 'lib/aws/sqs/received_message.rb', line 173

def approximate_receive_count
  (count = attributes["ApproximateReceiveCount"] and
   count.to_i) or nil
end

#as_sns_message ⇒ ReceivedSNSMessage

When SNS publishes messages to SQS queues the message body is formatted as a json message and then base 64 encoded.

Examples:


sns_msg = message.as_sns_message

sns_msg.topic
#=> <AWS::SNS::Topic ...>

sns_msg.to_h.inspect
#=> { :body => '...', :topic_arn => ... }

Returns:



82
83
84
 
# File 'lib/aws/sqs/received_message.rb', line 82

def as_sns_message
  ReceivedSNSMessage.new(body, :config => config)
end

#delete ⇒ nil

Note:

It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.

Deletes the message from the queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for more than 4 days, SQS automatically deletes it.

If you use Queue#poll or Queue#receive_message in block form, the messages you receive will be deleted automatically unless an exception occurs while you are processing them. You can still use this method if you want to delete a message early and then continue processing it.

Returns:

  • (nil) 


108
109
110
111
112
113
 
# File 'lib/aws/sqs/received_message.rb', line 108

def delete
  client.delete_message(
    :queue_url => queue.url,
    :receipt_handle => handle)
  nil
end

#sender_id ⇒ String

Returns The AWS account number (or the IP address, if anonymous access is allowed) of the sender.

Returns:

  • (String) —

    The AWS account number (or the IP address, if anonymous access is allowed) of the sender.



157
158
159
 
# File 'lib/aws/sqs/received_message.rb', line 157

def sender_id
  attributes["SenderId"]
end

#sent_timestamp ⇒ Time Also known as: sent_at

Returns The time when the message was sent.

Returns:

  • (Time) —

    The time when the message was sent.



162
163
164
165
166
167
168
 
# File 'lib/aws/sqs/received_message.rb', line 162

def sent_timestamp
  @sent_at ||=
    (timestamp = attributes["SentTimestamp"] and
     Time.at(timestamp.to_i / 1000.0)) || nil
rescue RangeError => e
  p [timestamp, timestamp.to_i]
end

#visibility_timeout=(timeout) ⇒ Object

Note:

If you attempt to set the timeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.

Note:

Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with this method.

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)

For example, let's say the timeout for the queue is 30 seconds, and you receive a message. Once you're 20 seconds into the timeout for that message (i.e., you have 10 seconds left), you extend it by 60 seconds by calling this method with timeout set to 60 seconds. You have then changed the remaining visibility timeout from 10 seconds to 60 seconds.

Returns:

  • Returns the timeout argument as passed.



146
147
148
149
150
151
152
153
 
# File 'lib/aws/sqs/received_message.rb', line 146

def visibility_timeout=(timeout)
  client.change_message_visibility(
    :queue_url => queue.url,
    :receipt_handle => handle,
    :visibility_timeout => timeout
  )
  timeout
end