Represents information pertaining to the execution of an asynchronous geoprocessor request on the server.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | The unique job ID assigned by ArcGIS Server. more details | JobInfo | |
String | The job status. more details | JobInfo | |
GPMessage[] | An array of messages that include the message type and a description. more details | JobInfo | |
Object | Displays the progress of the geoprocessing job. more details | JobInfo | |
Object | The options to be used for data requests. more details | JobInfo | |
String | ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request. more details | JobInfo |
Property Details
-
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.
-
progress ObjectreadonlySince: ArcGIS Maps SDK for JavaScript 4.26
-
Displays the progress of the geoprocessing job. This value is only present when jobStatus is
job-executing
and is only updated every five seconds.Example// Submit an asynchronous geoprocessing job const jobInfo = await submitJob(url, params); // Define a callback that will be called periodically. The function will print the // geoprocessor's progress and percentage complete (if a step progressor). const statusCallback = ({ jobStatus, progress }) => { if (jobStatus !== "job-executing") { return; } const { message, percent } = progress; const status = `Message: ${message} Progress: ${percent ?? "not specified"}` console.log(`Status: ${status}`); }; // Wait for the geoprocessing job to complete and print job progress // to the console every five seconds await jobInfo.waitForJobCompletion({ interval: 5000, statusCallback });
-
requestOptions Object
-
The options to be used for data requests. These options can also be controlled through the
requestOptions
method parameter.
-
sourceUrl String
-
ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Promise<JobInfo> | Cancels an asynchronous geoprocessing job. more details | JobInfo | |
Promise<JobInfo> | Sends a request for the current state of this job. more details | JobInfo | |
Stop monitoring this job for status updates. more details | JobInfo | ||
Promise<ParameterValue> | Sends a request to the GP Task to get the task result identified by | JobInfo | |
Promise<ParameterValue> | Sends a request to the GP Task to get the task result identified by | JobInfo | |
Promise<MapImageLayer> | Get the task result identified by | JobInfo | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | JobInfo | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | JobInfo | |
Promise<JobInfo> | Resolves when an asynchronous job has completed. more details | JobInfo |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Cancels an asynchronous geoprocessing job. Requires an ArcGIS Server 10.1 service or greater.
ParametersjobId StringA string that uniquely identifies a job on the server. It is created when a job is submitted for execution and later used to check its status and retrieve the results.
requestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
ReturnsType Description Promise<JobInfo> When resolved, returns a JobInfo.
-
Sends a request for the current state of this job.
ParameterrequestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
ReturnsType Description Promise<JobInfo> When resolved, returns a JobInfo.
-
destroy()
-
Stop monitoring this job for status updates.
// Stop monitoring this job for status updates. jobInfo.destroy();
- See also
-
fetchResultData(resultName, gpOptions, requestOptions){Promise<ParameterValue>}
-
Sends a request to the GP Task to get the task result identified by
resultName
.ParametersresultName StringThe name of the result parameter as defined in Services Directory.
gpOptions GPOptionsoptionalInput options for the geoprocessing service return values.
requestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
ReturnsType Description Promise<ParameterValue> When resolved, returns an object with a property named result
of type ParameterValue, which contains the result parameters and the task execution messages.
-
fetchResultImage(jobId, resultName, imageParams, requestOptions){Promise<ParameterValue>}
-
Sends a request to the GP Task to get the task result identified by
jobId
andresultName
as an image.ParametersjobId StringThe jobId returned from JobInfo.
resultName StringThe name of the result parameter as defined in the Services Directory.
imageParams ImageParametersSpecifies the properties of the result image.
requestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
ReturnsType Description Promise<ParameterValue> When resolved, returns an Object with a mapImage
property of type MapImage
-
fetchResultMapImageLayer(jobId){Promise<MapImageLayer>}
-
Get the task result identified by
jobId
as an MapImageLayer.ParameterjobId StringThe jobId returned from JobInfo.
ReturnsType Description Promise<MapImageLayer> A promise resolving to an instance of MapImageLayer. Example// Get the resulting map image layer from a completed geoprocessing job. jobInfo.fetchResultMapImageLayer(jobInfo.jobId)).then(function(layer){ view.map.add(layer); });
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
json
parameter 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
-
Resolves when an asynchronous job has completed. Optionally job progress can be monitored.
ParametersSpecificationoptions ObjectoptionalOptions. See properties below for object specifications.
Specificationinterval ObjectoptionalDefault Value: 1000The time in millisecond between remote job status requests.
signal ObjectoptionalAbortSignal allows for cancelable asynchronous job. If canceled, the promise will be rejected with an error named
AbortError
.statusCallback ObjectoptionalCallback function that is called at the specified interval. Use this method to monitor job status and messages.
ReturnsType Description Promise<JobInfo> When resolved, returns a JobInfo. Example// Submit an asynchronous geoprocessing job. Display the remote job status every 1.5 seconds. // When the job has completed, the output is a MapImageLayer. const startDate = "1998-01-01 00:00:00"; const endDate = "1998-05-31 00:00:00"; const params = { query: "(Date >= date '" + startDate + "' and Date <= date '" + endDate + "')" }; const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/911CallsHotspot/GPServer/911%20Calls%20Hotspot"; submitJob(url, params).then((jobInfo) => { const jobid = jobInfo.jobId; console.log("ArcGIS Server job ID: ", jobid); const options = { interval: 1500, statusCallback: (j) => { console.log("Job Status: ", j.jobStatus); } }; jobInfo.waitForJobCompletion(options).then(() => { const layer = jobInfo.fetchResultMapImageLayer(); map.add(layer); }); });