Class: Barbeque::Message::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/barbeque/message/base.rb

Overview

A model wrapping Aws::SQS::Types::Message.

Direct Known Subclasses

InvalidMessage, JobExecution, JobRetry, Notification

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(raw_message, message_body) ⇒ Base

Returns a new instance of Base.

Parameters:

  • raw_message (Aws::SQS::Types::Message)
  • message_body (Hash) —

    parse result of ‘raw_message.body`



12
13
14
15
16
17
 
# File 'lib/barbeque/message/base.rb', line 12

def initialize(raw_message, message_body)
  assign_body(message_body)
  @id             = raw_message.message_id
  @receipt_handle = raw_message.receipt_handle
  @sent_timestamp = raw_message.attributes['SentTimestamp']
end

Instance Attribute Details

#id ⇒ Object (readonly)

String

Barbeque::JobExecution is associated via ‘message_id`



5
6
7
 
# File 'lib/barbeque/message/base.rb', line 5

def id
  @id
end

#receipt_handle ⇒ Object (readonly)

String

Used to ack a message



6
7
8
 
# File 'lib/barbeque/message/base.rb', line 6

def receipt_handle
  @receipt_handle
end

#sent_timestamp ⇒ Object (readonly)

String

The time the message was sent to the queue (epoch time in milliseconds)



8
9
10
 
# File 'lib/barbeque/message/base.rb', line 8

def sent_timestamp
  @sent_timestamp
end

#type ⇒ Object (readonly)

String

“JobExecution”, “JobRetry”, etc



7
8
9
 
# File 'lib/barbeque/message/base.rb', line 7

def type
  @type
end

Instance Method Details

#valid? ⇒ Boolean

To distinguish with ‘Barbeque::Message::InvalidMessage`

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/barbeque/message/base.rb', line 20

def valid?
  true
end