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.api.taskqueue.taskqueue_stub._Group Class Reference
Inheritance diagram for google.appengine.api.taskqueue.taskqueue_stub._Group:

Public Member Functions

def __init__
 
def GetQueuesAsDicts
 
def HasQueue
 
def GetQueue
 
def GetNextPushTask
 
def BulkAdd_Rpc
 
def UpdateQueue_Rpc
 
def FetchQueues_Rpc
 
def FetchQueueStats_Rpc
 
def QueryTasks_Rpc
 
def FetchTask_Rpc
 
def Delete_Rpc
 
def DeleteQueue_Rpc
 
def PauseQueue_Rpc
 
def PurgeQueue_Rpc
 
def QueryAndOwnTasks_Rpc
 
def ModifyTaskLease_Rpc
 

Detailed Description

A taskqueue group.

This class contains all of the queues for an application.

Constructor & Destructor Documentation

def google.appengine.api.taskqueue.taskqueue_stub._Group.__init__ (   self,
  queue_yaml_parser = None,
  app_id = None,
  _all_queues_valid = False,
  _update_newest_eta = None,
  _testing_validate_state = False 
)
Constructor.

Args:
  queue_yaml_parser: A function that takes no parameters and returns the
  parsed results of the queue.yaml file. If this queue is not based on a
  queue.yaml file use None.
  app_id: The app id this Group is representing or None if it is the
  currently running application.
  _all_queues_valid: Automatically generate queues on first access.
  _update_newest_eta: Callable for automatically executing tasks.
  Takes the ETA of the task in seconds since the epoch, the queue_name
  and a task name. May be None if automatic task running is disabled.
  _testing_validate_state: Should this _Group and all of its _Queues
  validate their state after each operation? This should only be used
  during testing of the taskqueue_stub.

Member Function Documentation

def google.appengine.api.taskqueue.taskqueue_stub._Group.BulkAdd_Rpc (   self,
  request,
  response 
)
Add many tasks to a queue using a single request.

Args:
  request: The taskqueue_service_pb.TaskQueueBulkAddRequest. See
  taskqueue_service.proto.
  response: The taskqueue_service_pb.TaskQueueBulkAddResponse. See
  taskqueue_service.proto.
def google.appengine.api.taskqueue.taskqueue_stub._Group.Delete_Rpc (   self,
  request,
  response 
)
Implementation of the Delete RPC.

Deletes tasks from the task store.

Args:
  request: A taskqueue_service_pb.TaskQueueDeleteRequest.
  response: A taskqueue_service_pb.TaskQueueDeleteResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.DeleteQueue_Rpc (   self,
  request,
  response 
)
Implementation of the DeleteQueue RPC.

Tombstones the queue.

Args:
  request: A taskqueue_service_pb.TaskQueueDeleteQueueRequest.
  response: A taskqueue_service_pb.TaskQueueDeleteQueueResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.FetchQueues_Rpc (   self,
  request,
  response 
)
Implementation of the FetchQueues RPC.

Args:
  request: A taskqueue_service_pb.TaskQueueFetchQueuesRequest.
  response: A taskqueue_service_pb.TaskQueueFetchQueuesResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.FetchQueueStats_Rpc (   self,
  request,
  response 
)
Implementation of the FetchQueueStats rpc which returns 'random' data.

This implementation loads some stats from the task store, the rest are
random numbers.

Args:
  request: A taskqueue_service_pb.TaskQueueFetchQueueStatsRequest.
  response: A taskqueue_service_pb.TaskQueueFetchQueueStatsResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.FetchTask_Rpc (   self,
  request,
  response 
)
Implementation of the FetchTask RPC.

Args:
  request: A taskqueue_service_pb.TaskQueueFetchTaskRequest.
  response: A taskqueue_service_pb.TaskQueueFetchTaskResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.GetNextPushTask (   self)
Finds the task with the lowest eta.

Returns:
  A tuple containing the queue and task instance for the task with the
  lowest eta, or (None, None) if there are no tasks.
def google.appengine.api.taskqueue.taskqueue_stub._Group.GetQueue (   self,
  queue_name 
)
Gets the _Queue instance for the specified queue.

Args:
  queue_name: The name of the queue to fetch.

Returns:
  The _Queue instance for the specified queue.

Raises:
  KeyError if the queue does not exist.
def google.appengine.api.taskqueue.taskqueue_stub._Group.GetQueuesAsDicts (   self)
Gets all the applications's queues.

Returns:
  A list of dictionaries, where each dictionary contains one queue's
  attributes. E.g.:
[{'name': 'some-queue',
  'max_rate': '1/s',
  'bucket_size': 5,
  'oldest_task': '2009/02/02 05:37:42',
  'eta_delta': '0:00:06.342511 ago',
  'tasks_in_queue': 12,
  'acl': ['user1@gmail.com']}, ...]
  The list of queues always includes the default queue.
def google.appengine.api.taskqueue.taskqueue_stub._Group.HasQueue (   self,
  queue_name 
)
Check if the specified queue_name references a valid queue.

Args:
  queue_name: The name of the queue to check.

Returns:
  True if the queue exists, False otherwise.
def google.appengine.api.taskqueue.taskqueue_stub._Group.ModifyTaskLease_Rpc (   self,
  request,
  response 
)
Implementation of the ModifyTaskLease RPC.

Args:
  request: A taskqueue_service_pb.TaskQueueModifyTaskLeaseRequest.
  response: A taskqueue_service_pb.TaskQueueModifyTaskLeaseResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.PauseQueue_Rpc (   self,
  request,
  response 
)
Implementation of the PauseQueue RPC.

Args:
  request: A taskqueue_service_pb.TaskQueuePauseQueueRequest.
  response: A taskqueue_service_pb.TaskQueuePauseQueueResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.PurgeQueue_Rpc (   self,
  request,
  response 
)
Implementation of the PurgeQueue RPC.

Args:
  request: A taskqueue_service_pb.TaskQueuePurgeQueueRequest.
  response: A taskqueue_service_pb.TaskQueuePurgeQueueResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.QueryAndOwnTasks_Rpc (   self,
  request,
  response 
)
Implementation of the QueryAndOwnTasks RPC.

Args:
  request: A taskqueue_service_pb.TaskQueueQueryAndOwnTasksRequest.
  response: A taskqueue_service_pb.TaskQueueQueryAndOwnTasksResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.QueryTasks_Rpc (   self,
  request,
  response 
)
Implementation of the QueryTasks RPC.

Args:
  request: A taskqueue_service_pb.TaskQueueQueryTasksRequest.
  response: A taskqueue_service_pb.TaskQueueQueryTasksResponse.
def google.appengine.api.taskqueue.taskqueue_stub._Group.UpdateQueue_Rpc (   self,
  request,
  response 
)
Implementation of the UpdateQueue RPC.

Args:
  request: A taskqueue_service_pb.TaskQueueUpdateQueueRequest.
  response: A taskqueue_service_pb.TaskQueueUpdateQueueResponse.

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