JobInfo
esri/tasks/support/JobInfoRepresents information pertaining to the execution of an asynchronous Geoprocessor task on the server.
- See also:
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The unique job ID assigned by ArcGIS Server. more details | more details | JobInfo | |
| String | The job status. more details | more details | JobInfo | |
| GPMessage[] | An array of messages that include the message type and a description. more details | more details | JobInfo |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- jobId String
The unique job ID assigned by ArcGIS Server.
- jobStatus String
The job status.
Possible Values:"job-cancelled"|"job-cancelling"|"job-deleted"|"job-deleting"|"job-timed-out"|"job-executing"|"job-failed"|"job-new"|"job-submitted"|"job-succeeded"|"job-waiting"
An array of messages that include the message type and a description.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | JobInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | JobInfo |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.