Database Reference
In-Depth Information
JobStatus
The job status object, shown in
Table 5.14
, will let you know whether the
job has started or whether it had any errors. The
state
field will always
be either
PENDING
,
RUNNING
, or
DONE
. If the job failed, the reason for the
failure will be in the
errorResult
field. The
error
field also contains a
list of errors but does not necessarily indicate that the job failed. Instead,
the errors in the
error
list should be thought of as warnings when the
errorResult
is not present.
Table 5.14
JobStatus Components
Field Type Description
state string
Either
PENDING
, to indicate the job
is still queued;
RUNNING
, to indicate
the job is actively running; or
DONE
to indicate the job has completed
and all side effects are committed.
errorResult object
If present, the error that caused the
job to fail.
errorResult.location string
Optional location of the error.
errorResult.message string
A user-readable description of the
error.
string
A short error code describing the
error, such as
notFound
. If you
have code that handles errors, the
reason should be used to make
decisions about the type of error,
rather than the message, which may
change at any time.
errorResult.reason
All the errors that occurred on the
job. Presence of errors in this field
does not necessarily indicate job
failure.
errors
object
array
