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.ext.mapreduce.hooks.Hooks Class Reference
Inheritance diagram for google.appengine.ext.mapreduce.hooks.Hooks:

Public Member Functions

def __init__
 
def enqueue_worker_task
 
def enqueue_kickoff_task
 
def enqueue_done_task
 
def enqueue_controller_task
 

Public Attributes

 mapreduce_spec
 

Detailed Description

Allows subclasses to control some aspects of mapreduce execution.

control.start_map accepts an optional "hooks" argument that can be passed a
subclass of this class.

Constructor & Destructor Documentation

def google.appengine.ext.mapreduce.hooks.Hooks.__init__ (   self,
  mapreduce_spec 
)
Initializes a Hooks class.

Args:
  mapreduce_spec: The mapreduce.model.MapreduceSpec for the current
mapreduce.

Member Function Documentation

def google.appengine.ext.mapreduce.hooks.Hooks.enqueue_controller_task (   self,
  task,
  queue_name 
)
Enqueues a task that is used to monitor the mapreduce process.

Args:
  task: A taskqueue.Task that must be queued in order for updates to the
mapreduce process to be properly tracked. The task is named.
  queue_name: The queue where the task should be run e.g. "default".

Raises:
  NotImplementedError: to indicate that the default mapreduce tracking
strategy should be used.
def google.appengine.ext.mapreduce.hooks.Hooks.enqueue_done_task (   self,
  task,
  queue_name 
)
Enqueues a task that is triggered when the mapreduce completes.

This hook will be called within a transaction scope.
Hook should add task transactionally.

Args:
  task: A taskqueue.Task that must be queued in order for the client to be
notified when the mapreduce is complete.
  queue_name: The queue where the task should be run e.g. "default".

Raises:
  NotImplementedError: to indicate that the default mapreduce notification
strategy should be used.
def google.appengine.ext.mapreduce.hooks.Hooks.enqueue_kickoff_task (   self,
  task,
  queue_name 
)
Enqueues a task that is used to start the mapreduce.

This hook will be called within a transaction scope.
Hook should add task transactionally.

Args:
  task: A taskqueue.Task that must be queued to run KickOffJobHandler.
  queue_name: The queue where the task should be run e.g. "default".

Raises:
  NotImplementedError: to indicate that the default mapreduce start strategy
should be used.
def google.appengine.ext.mapreduce.hooks.Hooks.enqueue_worker_task (   self,
  task,
  queue_name 
)
Enqueues a worker task that is used to run the mapper.

Args:
  task: A taskqueue.Task that must be queued in order for the mapreduce
mappers to be run. The task is named.
  queue_name: The queue where the task should be run e.g. "default".

Raises:
  NotImplementedError: to indicate that the default worker queueing strategy
should be used.

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