Class GeoprocessingTask

GeoprocessingTask is used to run geoprocessing task that is published as a web service.

Inheritance

Object

GeoprocessingTask

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Esri.ArcGISRuntime.Tasks.Geoprocessing

Assembly: Esri.ArcGISRuntime.dll

Syntax

public sealed class GeoprocessingTask

Remarks

GeoprocessingTask is the main component when running geoprocessing tasks. The task might be published through ArcGIS Server or Local server (on the platforms that supports it) using either synchronous execute or asynchronous submit execution type. When GeoprocessingParameters is created it is important to match GeoprocessingExecutionType to the value on the service.

1. Create GeoprocessingTask using full URL to the target geoprocessing task endpoint.
2. Create GeoprocessingParameters providing corresponding GeoprocessingExecutionType
3. Create needed GeoprocessingParameters and add them to Inputs where key is the name of the parameter and value is created parameter.
4. Set environmental variables on GeoprocessingParameters if needed.
5. Create GeoprocessingJob with CreateJob(GeoprocessingParameters).
6. Start listening for status and message changes using JobChanged event.
7. Run targeted geoprocessing tool using GetResultAsync() which returns GeoprocessingResult when finished.
8. Handle returned values accordingly. Access output parameters through Outputs dictionary where key is the name of the output parameter and the value is returned parameter. If used geoprocessing service is configured to use result map service MapImageLayer might be created for you.

Properties

Name	Description
Credential	Gets or sets the security credential used to access a remote task.
GeoprocessingTaskInfo	Gets the metadata of this geoprocessing task.
Source	Gets the source URL that points to a task within a ArcGIS REST geoprocessing service.

Methods

Name	Description
CreateAsync(Uri)	Initializes a new instance of the GeoprocessingTask class with the given URL that points to a task within an ArcGIS REST geoprocessing service.
CreateAsync(Uri, Credential)	Initializes a new instance of the GeoprocessingTask class with the given URL that points to a task within an ArcGIS REST geoprocessing service.
CreateDefaultParametersAsync()	Creates default parameters for a geoprocessing task.
CreateJob(GeoprocessingParameters)	Returns a job that when started will run a geoprocessing task on the service.

Applies to

Target	Versions
.NET Standard 2.0	100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0
.NET Framework	100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0
.NET 5	100.12.0, 100.11.0, 100.10.0
.NET Core	100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0
Xamarin.Android	100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0
Xamarin.iOS	100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0
UWP	100.12.0, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0

Relevant samples

Analyze hotspots: Use a geoprocessing service and a set of features to identify statistically significant hot spots and cold spots.

List geodatabase versions: Connect to a service and list versions of the geodatabase.