App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | List of all members
google.appengine.api.taskqueue.taskqueue.QueueStatistics Class Reference
Inheritance diagram for google.appengine.api.taskqueue.taskqueue.QueueStatistics:

Public Member Functions

def __init__
 
def __eq__
 
def __ne__
 
def __repr__
 
def fetch_async
 
def fetch
 

Public Attributes

 queue
 
 tasks
 
 oldest_eta_usec
 
 executed_last_minute
 
 in_flight
 
 enforced_rate
 

Detailed Description

Represents the current state of a Queue.

Constructor & Destructor Documentation

def google.appengine.api.taskqueue.taskqueue.QueueStatistics.__init__ (   self,
  queue,
  tasks,
  oldest_eta_usec = None,
  executed_last_minute = None,
  in_flight = None,
  enforced_rate = None 
)
Constructor.

Args:
  queue: The Queue instance this QueueStatistics is for.
  tasks: The number of tasks left.
  oldest_eta_usec: The eta of the oldest non-completed task for the queue;
None if unknown.
  executed_last_minute: The number of tasks executed in the last minute.
  in_flight: The number of tasks that are currently executing.
  enforced_rate: The current enforced rate. In tasks/second.

Member Function Documentation

def google.appengine.api.taskqueue.taskqueue.QueueStatistics.fetch (   cls,
  queue_or_queues,
  deadline = 10 
)
Get the queue details for multiple queues.

Args:
  queue_or_queues: An iterable of Queue instances, or an iterable of
  strings corresponding to queue names, or a Queue instance or a string
  corresponding to a queue name.
  deadline: The maximum number of seconds to wait before aborting the
  method call.

Returns:
  If an iterable (other than string) is provided as input, a list of of
  QueueStatistics objects will be returned, one for each queue in the order
  requested.

  Otherwise, if a single item was provided as input, then a single
  QueueStatistics object will be returned.

Raises:
  TypeError: If queue_or_queues is not one of: Queue instance, string, an
  iterable containing only Queue instances or an iterable containing
  only strings.
  Error-subclass on application errors.
def google.appengine.api.taskqueue.taskqueue.QueueStatistics.fetch_async (   cls,
  queue_or_queues,
  rpc = None 
)
Asynchronously get the queue details for multiple queues.

Args:
  queue_or_queues: An iterable of Queue instances, or an iterable of
  strings corresponding to queue names, or a Queue instance or a string
  corresponding to a queue name.
  rpc: An optional UserRPC object.

Returns:
  A UserRPC object, call get_result to complete the RPC and obtain the
  result.

  If an iterable (other than string) is provided as input, the result will
  be a list of of QueueStatistics objects, one for each queue in the order
  requested.

  Otherwise, if a single item was provided as input, then the result will be
  a single QueueStatistics object.

Raises:
  TypeError: If queue_or_queues is not one of: Queue instance, string, an
  iterable containing only Queue instances or an iterable containing
  only strings.

The documentation for this class was generated from the following file: