Class: Fog::Rackspace::Queues::Messages

Inherits:

Collection

• Object
• Collection
• Fog::Rackspace::Queues::Messages

Defined in:

lib/fog/rackspace/models/queues/messages.rb

Instance Attribute Summary

• #client_id ⇒ String

  UUID for the client instance.

• #echo ⇒ Boolean

  Determines whether the API returns a client’s own messages.

• #include_claimed ⇒ String

  Determines whether the API returns claimed messages and unclaimed messages.

• #limit ⇒ String

  When more messages are available than can be returned in a single request, the client can pick up the next batch of messages by simply using the URI template parameters returned from the previous call in the “next” field.

• #marker ⇒ String

  Specifies an opaque string that the client can use to request the next batch of messages.

• #queue ⇒ String

  The name of the queue associated with the message.

Instance Method Summary

• #all ⇒ Fog::Rackspace::Queues::Messages

  Returns list of messages.

• #get(message_id) ⇒ Fog::Rackspace::Queues::Claim

  Returns the specified message from the queue.

Instance Attribute Details

#client_id ⇒ String

# File 'lib/fog/rackspace/models/queues/messages.rb', line 12

def client_id
  @client_id
end

#echo ⇒ Boolean

# File 'lib/fog/rackspace/models/queues/messages.rb', line 22

def echo
  @echo
end

#include_claimed ⇒ String

# File 'lib/fog/rackspace/models/queues/messages.rb', line 39

def include_claimed
  @include_claimed
end

#limit ⇒ String

# File 'lib/fog/rackspace/models/queues/messages.rb', line 28

def limit
  @limit
end

#marker ⇒ String

# File 'lib/fog/rackspace/models/queues/messages.rb', line 33

def marker
  @marker
end

#queue ⇒ String

# File 'lib/fog/rackspace/models/queues/messages.rb', line 16

def queue
  @queue
end

Instance Method Details

#all ⇒ Fog::Rackspace::Queues::Messages

Returns list of messages

Raises:

• (Fog::Rackspace::Queues::NotFound) —

  • HTTP 404

• (Fog::Rackspace::Queues::BadRequest) —

  • HTTP 400

• (Fog::Rackspace::Queues::InternalServerError) —

  • HTTP 500

# File 'lib/fog/rackspace/models/queues/messages.rb', line 47

def all
  requires :client_id, :queue
  response = service.list_messages(client_id, queue.name, options)
  if response.status == 204
    data = []
  else
    data = response.body['messages']
  end
  load(data)
end

#get(message_id) ⇒ Fog::Rackspace::Queues::Claim

Returns the specified message from the queue.

Raises:

• (Fog::Rackspace::Queues::BadRequest) —

  • HTTP 400

• (Fog::Rackspace::Queues::InternalServerError) —

  • HTTP 500

• (Fog::Rackspace::Queues::ServiceError)

# File 'lib/fog/rackspace/models/queues/messages.rb', line 65

def get(message_id)
  requires :client_id, :queue
  data = service.get_message(client_id, queue.name, message_id).body
  new(data)
rescue Fog::Rackspace::Queues::NotFound
  nil
# HACK - This has been escalated to the Rackspace Queues team, as this
# behavior is not normal HTTP behavior.
rescue Fog::Rackspace::Queues::ServiceError
  nil
end