require(["esri/tasks/Geoprocessor"], function(Geoprocessor) { /* code goes here */ });
Class: esri/tasks/Geoprocessor
Inheritance: Geoprocessor Task Accessor
Since: ArcGIS API for JavaScript 4.0

Represents a GP Task resource exposed by the ArcGIS REST API. A GP Task resource represents a single task in a GP service published using the ArcGIS Server and it supports one of the following operations dependent on how the service was set up:

  • execute - for when the execution type is synchronous.
  • submitJob - for when the execution type is asynchronous.
See also:

Constructors

new Geoprocessor(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
SpatialReference

The spatial reference of the output geometries.

more details
more detailsGeoprocessor
SpatialReference

The spatial reference that the model will use to perform geometry operations.

more details
more detailsGeoprocessor
Object

The options to be used for data requests.

more details
more detailsTask
Number

The time interval in milliseconds between each job status request sent to an asynchronous GP task.

more details
more detailsGeoprocessor
String

ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.

more details
more detailsGeoprocessor

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

outSpatialReferenceSpatialReference

The spatial reference of the output geometries. If not specified, the output geometries will be in the spatial reference of the input geometries. If processSpatialReference is specified and outSpatialReference is not specified, the output geometries will be in the spatial reference of the process spatial reference.

processSpatialReferenceSpatialReference

The spatial reference that the model will use to perform geometry operations. If processSpatialReference is specified and outputSpatialReference is not specified, the output geometries will be in the spatial reference of the process spatial reference.

requestOptionsObject inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

updateDelayNumber

The time interval in milliseconds between each job status request sent to an asynchronous GP task.

Default Value: 1000

ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.

Method Overview

NameReturn TypeSummaryClass
Promise<Object>

Cancels an asynchronous geoprocessing job.

more details
more detailsGeoprocessor

Cancels the periodic job status updates automatically initiated when submitJob() is invoked for the job identified by jobId.

more details
more detailsGeoprocessor
Promise<Object>

Sends a request to the GP Task for the current state of the job identified by jobId.

more details
more detailsGeoprocessor
Promise<Object>

Sends a request to the server to execute a synchronous GP task.

more details
more detailsGeoprocessor
Promise<Object>

Sends a request to the GP Task to get the task result identified by jobId and resultName.

more details
more detailsGeoprocessor
Promise<Object>

Sends a request to the GP Task to get the task result identified by jobId and resultName as an image.

more details
more detailsGeoprocessor
MapImageLayer

Get the task result identified by jobId as an MapImageLayer.

more details
more detailsGeoprocessor
Promise<Object>

Submits a job to the server for asynchronous processing by the GP task.

more details
more detailsGeoprocessor

Method Details

cancelJob(jobId, requestOptions){Promise<Object>}

Cancels an asynchronous geoprocessing job. Requires an ArcGIS Server 10.1 service or greater.

Parameters:
jobId String

A 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 Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>When resolved, returns an object that includes the status and job ID.

cancelJobStatusUpdates(jobId)

Cancels the periodic job status updates automatically initiated when submitJob() is invoked for the job identified by jobId. You can still obtain the status of this job by calling the checkJobStatus() method at your own discretion.

Parameter:
jobId String

A string that uniquely identifies the job for which the job updates are cancelled.

checkJobStatus(jobId, requestOptions){Promise<Object>}

Sends a request to the GP Task for the current state of the job identified by jobId.

Parameters:
jobId String

The jobId returned from JobInfo.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>When resolved, returns the status of the job as a property of an Object.

execute(params, requestOptions){Promise<Object>}

Sends a request to the server to execute a synchronous GP task.

Parameters:
params Object

Specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters:

  • <GPFeatureRecordSetLayer> Input_Points
  • <GPDouble> Distance

The params argument would then be an Object of the form:

{
 Input_Points: <FeatureSet>,
 Distance: <Number>
}

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>When resolved, returns an object with the following properties:
{
  messages: <GPMessage[]>,
  results: <ParameterValue[]>
}
See the GPMessage and ParameterValue classes for more information about the information in this object.

getResultData(jobId, resultName, requestOptions){Promise<Object>}

Sends a request to the GP Task to get the task result identified by jobId and resultName.

Parameters:
jobId String

The jobId returned from JobInfo.

resultName String

The name of the result parameter as defined in Services Directory.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>When resolved, returns an object with a property named result of type ParameterValue, which contains the result parameters and the task execution messages.

getResultImage(jobId, resultName, imageParams, requestOptions){Promise<Object>}

Sends a request to the GP Task to get the task result identified by jobId and resultName as an image.

Parameters:
jobId String

The jobId returned from JobInfo.

resultName String

The name of the result parameter as defined in the Services Directory.

imageParams ImageParameters

Specifies the properties of the result image.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>When resolved, returns an Object with a mapImage property of type MapImage

getResultMapImageLayer(jobId){MapImageLayer}

Since: ArcGIS API for JavaScript 4.1

Get the task result identified by jobId as an MapImageLayer. This method supports MapImageLayer 10.1 or greater.

Parameter:
jobId String

The jobId returned from JobInfo.

Returns:
TypeDescription
MapImageLayerReturns an instance of MapImageLayer.

submitJob(params, requestOptions){Promise<Object>}

Submits a job to the server for asynchronous processing by the GP task.

The task execution results can be retrieved using the getResultData(), getResultImage(), or getResultMapImageLayer() methods.

Parameters:
params Object

specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters:

  • <GPFeatureRecordSetLayer> Input_Points
  • <GPDouble> Distance

The params argument would then be an Object of the form:

{
 Input_Points: <FeatureSet>,
 Distance: <Number>
}

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>When resolved, returns an object with the following properties:
{
  messages: <GPMessage[]>,
  results: <ParameterValue[]>
}
See the GPMessage and ParameterValue classes for more information about the information in this object.

API Reference search results

NameTypeModule

There were no match results from your search criteria.