Interface
Describes the status of a job. See the GP Job documentation for more information.
Properties
| Property | Type | Notes |
|---|---|---|
id | string | The ID of the job. Can be used to rehydrate an instance of |
inputs | {} | An input property that are returned from a successful job. |
messages | { description: string; type: string }[] | A message property that are returned from a successful job. |
progress | { message: string; percentage: number; type: string } | A progress property that is returned while the job status is |
results | {} | A results property that are returned from a successful job. |
status | JOB_STATUSES | Represents the status of the current job. |
id
Interface Propertyid: stringThe ID of the job. Can be used to rehydrate an instance of Job with Job.fromExistingJob or Job.deserialize .
inputs
inputs: {}An input property that are returned from a successful job.
Type declaration
messages
messages: { description: string; type: string }[]A message property that are returned from a successful job.
progress
progress: { message: string; percentage: number; type: string }A progress property that is returned while the job status is JOB_STATUSES.Executing
Type declaration
results
results: {}A results property that are returned from a successful job.
Type declaration
status
Interface Propertystatus: JOB_STATUSESRepresents the status of the current job.