pyrax
Python Bindings for the Rackspace Cloud
 All Classes Namespaces Files Functions Variables Properties
Public Member Functions | Public Attributes
QueueMessageManager Class Reference

Manager class for a Queue Message. More...

Inheritance diagram for QueueMessageManager:
BaseQueueManager BaseManager

List of all members.

Public Member Functions

def list
 Need to form the URI differently, so we can't use the default list().
def delete
 Deletes the specified message from its queue.
def list_by_ids
 If you wish to retrieve a list of messages from this queue and know the IDs of those messages, you can pass in a list of those IDs, and only the matching messages will be returned.
def delete_by_ids
 Deletes the messages whose IDs are passed in from this queue.

Public Attributes

 plural_response_key

Detailed Description

Manager class for a Queue Message.


Member Function Documentation

def delete (   self,
  msg,
  claim_id = None 
)

Deletes the specified message from its queue.

If the message has been claimed, the ID of that claim must be passed as the 'claim_id' parameter.

def delete_by_ids (   self,
  ids 
)

Deletes the messages whose IDs are passed in from this queue.

def list (   self,
  include_claimed = False,
  echo = False,
  marker = None,
  limit = None 
)

Need to form the URI differently, so we can't use the default list().

Reimplemented from BaseManager.

def list_by_ids (   self,
  ids 
)

If you wish to retrieve a list of messages from this queue and know the IDs of those messages, you can pass in a list of those IDs, and only the matching messages will be returned.

This avoids pulling down all the messages in a queue and filtering on the client side.


Member Data Documentation

Reimplemented from BaseManager.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties