Abstract Class awJob

Description

Represents an asynchronous macro unit of work.

Located in /classes/cm/Job.php

awComplexObject
   |
   --awJob
Direct descendents
Class Description
 class awSimpleMutateJob A mutation job, which was submitted using mutate, and will execute asynchronously sometime after submission.
 class awBulkMutateJob A {@code BulkMutateJob} is essentially a mixed collection of mutate
Variable Summary
Method Summary
 void factory ( $row,  $className)
Variables
awBillingSummary $billingSummary

The billing summary specifying the cost of this job.

<span class="constraint ReadOnly">This field is read only and should not be set. If this field is sent to the API, it will be ignored.</span>

string $customerJobKey

Unique job key (per customer) for guarding against duplicate job submissions. This field is optional.

<span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET. If this field is sent to the API, it will be ignored.</span>

awApiErrorReason $failureReason

Failure reason if this job has failed.

<span class="constraint ReadOnly">This field is read only and should not be set. If this field is sent to the API, it will be ignored.</span>

awJobStats $stats

The statistics concerning the processing of this job.

<span class="constraint ReadOnly">This field is read only and should not be set. If this field is sent to the API, it will be ignored.</span>

mixed $_checkFields = array(
'failureReason' => array(
'objName' => 'awApiErrorReason',
'type' => 'obj'
),'stats'=>array('objName'=>'awJobStats','type'=>'obj'),'billingSummary'=>array('objName'=>'awBillingSummary','type'=>'obj'),)
  • access: public

Redefinition of:
awComplexObject::$_checkFields

Redefined in descendants as:

Inherited Variables

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row
Methods

Documentation generated on Fri, 23 Mar 2012 13:44:01 +0200 by phpDocumentor 1.4.3