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.api.map_job.map_job_control.Job Class Reference
Inheritance diagram for google.appengine.ext.mapreduce.api.map_job.map_job_control.Job:

Public Member Functions

def __init__
 
def get_job_by_id
 
def get_status
 
def abort
 
def get_counters
 
def get_counter
 
def get_outputs
 
def submit
 

Public Attributes

 job_config
 

Static Public Attributes

string RUNNING = "running"
 
 FAILED = model.MapreduceState.RESULT_FAILED
 
 ABORTED = model.MapreduceState.RESULT_ABORTED
 
 SUCCESS = model.MapreduceState.RESULT_SUCCESS
 
list STATUS_ENUM = [RUNNING, FAILED, ABORTED, SUCCESS]
 

Detailed Description

The job submitter's view of the job.

The class allows user to submit a job, control a submitted job,
query its state and result.

Constructor & Destructor Documentation

def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.__init__ (   self,
  state = None 
)
Init the job instance representing the job with id job_id.

Do not directly call this method. Use class methods to construct
new instances.

Args:
  state: model.MapreduceState.

Member Function Documentation

def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.abort (   self)
Aborts the job.
def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.get_counter (   self,
  counter_name,
  default = 0 
)
Get the value of the named counter from this job.

When a job is running, counter values won't be very accurate.

Args:
  counter_name: name of the counter in string.
  default: default value if the counter doesn't exist.

Returns:
  Value in int of the named counter.
def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.get_counters (   self)
Get counters from this job.

When a job is running, counter values won't be very accurate.

Returns:
  An iterator that returns (counter_name, value) pairs of type
  (basestring, int)
def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.get_job_by_id (   cls,
  job_id = None 
)
Gets the job instance representing the job with id job_id.

Args:
  job_id: a job id, job_config.job_id, of a submitted job.

Returns:
  A Job instance for job_id.
def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.get_outputs (   self)
Get outputs of this job.

Should only call if status is SUCCESS.

Yields:
  Iterators, one for each shard. Each iterator is
  from the argument of map_job.output_writer.commit_output.
def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.get_status (   self)
Get status enum.

Returns:
  One of the status enum.
def google.appengine.ext.mapreduce.api.map_job.map_job_control.Job.submit (   cls,
  job_config,
  in_xg_transaction = False 
)
Submit the job to run.

Args:
  job_config: an instance of map_job.MapJobConfig.
  in_xg_transaction: controls what transaction scope to use to start this MR
job. If True, there has to be an already opened cross-group transaction
scope. MR will use one entity group from it.
If False, MR will create an independent transaction to start the job
regardless of any existing transaction scopes.

Returns:
  a Job instance representing the submitted job.

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