Class Fog::Rackspace::Queues::Messages
In: lib/fog/rackspace/models/queues/messages.rb
Parent: Fog::Collection

Methods

all   get  

Attributes

client_id  [RW]  @!attribute [r] client_id @return [String] UUID for the client instance.
echo  [RW]  @!attribute [rw] echo @return [Boolean] Determines whether the API returns a client‘s own messages. The echo parameter is a Boolean value (true or false) that determines whether the API 
  returns a client's own messages, as determined by the uuid portion of the User-Agent header. If you do not specify a value, echo uses the default value of false.
  If you are experimenting with the API, you might want to set echo=true in order to see the messages that you posted.
include_claimed  [RW]  @!attribute [rw] include_claimed @return [String] Determines whether the API returns claimed messages and unclaimed messages. The include_claimed parameter is a Boolean value (true or false) 
  that determines whether the API returns claimed messages and unclaimed messages. If you do not specify a value, include_claimed uses the default value of false
  (only unclaimed messages are returned).
limit  [RW]  @!attribute [rw] limit @return [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. Specifies up to 10 messages (the default value) to return. If you do not specify a value
  for the limit parameter, the default value of 10 is used.
marker  [RW]  @!attribute [rw] marker @return [String] Specifies an opaque string that the client can use to request the next batch of messages. The marker parameter communicates to the server which 
  messages the client has already received. If you do not specify a value, the API returns all messages at the head of the queue (up to the limit).
queue  [RW]  @!attribute [r] queue @return [String] The name of the queue associated with the message.

Public Instance methods

all()

Returns list of messages

@return [Fog::Rackspace::Queues::Messages] Retrieves a collection of messages. @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404 @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400 @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500

get(message_id)

Returns the specified message from the queue.

@param [Integer] message_id id of the message to be retrieved @return [Fog::Rackspace::Queues::Claim] Returns a claim @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400 @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500 @raise [Fog::Rackspace::Queues::ServiceError]

[Validate]