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

Public Member Functions

def get_queues
 
def get_number_tasks_in_queue
 
def get_tasks
 
def delete_task
 
def purge_queue
 

Detailed Description

Taskqueue rpc wrapper.

Member Function Documentation

def google.appengine.ext.admin.TaskQueueHelper.delete_task (   self,
  queue_name,
  task_name 
)
Delete the named task.

Args:
  queue_name: The name of the queue.
  task_name: The name of the task.
def google.appengine.ext.admin.TaskQueueHelper.get_number_tasks_in_queue (   self,
  queue_name 
)
Returns the number of tasks in the named queue.

Args:
  queue_name: The name of the queue.

Returns:
  The number of tasks in the queue.
def google.appengine.ext.admin.TaskQueueHelper.get_queues (   self,
  now 
)
Get a list of queue in the application.

Args:
  now: The current time. A datetime.datetime object with a utc timezone.

Returns:
  A list of queue dicts corresponding to the tasks for this application.
def google.appengine.ext.admin.TaskQueueHelper.get_tasks (   self,
  now,
  queue_name,
  start_eta_usec,
  start_task_name,
  num_tasks 
)
Fetch the specified tasks from taskqueue.

Note: This only searchs by eta.

Args:
  now: The current time. This is used to calculate the EtaFromNow. Must be a
  datetime.datetime in the utc timezone.
  queue_name: The queue to search for tasks.
  start_eta_usec: The earliest eta to return.
  start_task_name: For tasks with the same eta_usec, this is used as a tie
  breaker.
  num_tasks: The maximum number of tasks to return.

Returns:
  A list of task dicts (as returned by
  taskqueue_stub.QueryTasksResponseToDict).
def google.appengine.ext.admin.TaskQueueHelper.purge_queue (   self,
  queue_name 
)
Purge the named queue.

Args:
  queue_name: the name of the queue.

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