Interface
Describes the status of a job. See the GP Job documentation for more information.
Properties
| Property | Type | Notes |
|---|---|---|
string | The ID of the job. Can be used to rehydrate an instance of | |
{ [key: string]: { paramUrl: string } } | An input property that are returned from a successful job. | |
{ description: string; type: string }[] | A message property that are returned from a successful job. | |
{ message: string; percentage: number; type: string } | A progress property that is returned while the job status is | |
{ [key: string]: { paramUrl: string } } | A results property that are returned from a successful job. | |
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: { [key: string]: { paramUrl: string } }An input property that are returned from a successful job.
Type declaration
- [key: string]: { paramUrl: string }
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: { [key: string]: { paramUrl: string } }A results property that are returned from a successful job.
Type declaration
- [key: string]: { paramUrl: string }
status
Interface Propertystatus: JOB_STATUSESRepresents the status of the current job.