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

Public Member Functions

def __init__
 
def add
 
def to_task
 
def decode_payload
 

Public Attributes

 url
 
 name
 
 eta
 
 countdown
 

Static Public Attributes

string PAYLOAD_PARAM = "__payload"
 
string PAYLOAD_KEY_PARAM = "__payload_key"
 
int MAX_TASK_PAYLOAD = taskqueue.MAX_PUSH_TASK_SIZE_BYTES-1024
 
 MAX_DB_PAYLOAD = datastore_rpc.BaseConnection.MAX_RPC_BYTES
 
string PAYLOAD_VERSION_HEADER = "AE-MR-Payload-Version"
 
string PAYLOAD_VERSION = "1"
 

Detailed Description

HugeTask is a taskqueue.Task-like class that can store big payloads.

Payloads are stored either in the task payload itself or in the datastore.
Task handlers should inherit from base_handler.HugeTaskHandler class.

Constructor & Destructor Documentation

def google.appengine.ext.mapreduce.model.HugeTask.__init__ (   self,
  url,
  params,
  name = None,
  eta = None,
  countdown = None,
  parent = None,
  headers = None 
)
Init.

Args:
  url: task url in str.
  params: a dict from str to str.
  name: task name.
  eta: task eta.
  countdown: task countdown.
  parent: parent entity of huge task's payload.
  headers: a dict of headers for the task.

Raises:
  ValueError: when payload is too big even for datastore, or parent is
not specified when payload is stored in datastore.

Member Function Documentation

def google.appengine.ext.mapreduce.model.HugeTask.add (   self,
  queue_name,
  transactional = False 
)
Add task to the queue.
def google.appengine.ext.mapreduce.model.HugeTask.decode_payload (   cls,
  request 
)
Decode task payload.

HugeTask controls its own payload entirely including urlencoding.
It doesn't depend on any particular web framework.

Args:
  request: a webapp Request instance.

Returns:
  A dict of str to str. The same as the params argument to __init__.

Raises:
  DeprecationWarning: When task payload constructed from an older
incompatible version of mapreduce.
def google.appengine.ext.mapreduce.model.HugeTask.to_task (   self)
Convert to a taskqueue task.

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