App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
google.appengine.ext.mapreduce.model.MapreduceSpec Class Reference
Inheritance diagram for google.appengine.ext.mapreduce.model.MapreduceSpec:
google.appengine.ext.mapreduce.json_util.JsonMixin

Public Member Functions

def __init__
 
def get_hooks
 
def to_json
 
def from_json
 
def __str__
 
def __eq__
 
- Public Member Functions inherited from google.appengine.ext.mapreduce.json_util.JsonMixin
def to_json_str
 
def from_json_str
 

Public Attributes

 name
 
 mapreduce_id
 
 mapper
 
 params
 
 hooks_class_name
 

Static Public Attributes

string PARAM_DONE_CALLBACK = "done_callback"
 
string PARAM_DONE_CALLBACK_QUEUE = "done_callback_queue"
 

Detailed Description

Contains a specification for the whole mapreduce.

MapreduceSpec instance can be changed only during mapreduce starting process,
and it remains immutable for the rest of mapreduce execution. MapreduceSpec is
passed as a payload to all mapreduce tasks in json encoding.

Constructor & Destructor Documentation

def google.appengine.ext.mapreduce.model.MapreduceSpec.__init__ (   self,
  name,
  mapreduce_id,
  mapper_spec,
  params = {},
  hooks_class_name = None 
)
Create new MapreduceSpec.

Args:
  name: The name of this mapreduce job type.
  mapreduce_id: ID of the mapreduce.
  mapper_spec: JSON-encoded string containing a MapperSpec.
  params: dictionary of additional mapreduce parameters.
  hooks_class_name: The fully qualified name of the hooks class to use.

Properties:
  name: The name of this mapreduce job type.
  mapreduce_id: unique id of this mapreduce as string.
  mapper: This MapreduceSpec's instance of MapperSpec.
  params: dictionary of additional mapreduce parameters.
  hooks_class_name: The fully qualified name of the hooks class to use.

Member Function Documentation

def google.appengine.ext.mapreduce.model.MapreduceSpec.from_json (   cls,
  json 
)
Create new MapreduceSpec from the json, encoded by to_json.

Args:
  json: json representation of MapreduceSpec.

Returns:
  an instance of MapreduceSpec with all data deserialized from json.
def google.appengine.ext.mapreduce.model.MapreduceSpec.get_hooks (   self)
Returns a hooks.Hooks class or None if no hooks class has been set.
def google.appengine.ext.mapreduce.model.MapreduceSpec.to_json (   self)
Serializes all data in this mapreduce spec into json form.

Returns:
  data in json format.

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