GeoprocessingTask is used to run a geoprocessing task that is published as a web service. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- createDefaultParametersResult : GeoprocessingParameters
- createDefaultParametersStatus : Enums.TaskStatus
- credential : Credential
- error : Error
- geoprocessingTaskInfo : GeoprocessingTaskInfo
- loadError : Error
- loadStatus : Enums.LoadStatus
- requestConfiguration : RequestConfiguration
- url : url
Signals
- createDefaultParametersStatusChanged()
- credentialChanged()
- geoprocessingTaskInfoChanged()
- loadErrorChanged()
- loadStatusChanged()
- requestConfigurationChanged()
- urlChanged()
Methods
- void cancelLoad()
- bool cancelTask(string taskId)
- string createDefaultParameters()
- GeoprocessingParameters createDefaultParametersResult()
- GeoprocessingJob createJob(GeoprocessingParameters parameters)
- void load()
- void retryLoad()
Detailed Description
GeoprocessingTask is the main component when running geoprocessing tasks. The task can be published through ArcGIS Server using either synchronous execute or asynchronous submit execution type. When GeoprocessingParameters is created to pass into createJob, it is important to match its executionType to the value on the service.
- Create a GeoprocessingTask using the full URL to the target geoprocessing task endpoint.
- Create a GeoprocessingParameters providing corresponding Enums.GeoprocessingExecutionType.
- Create the necessary GeoprocessingParameters and add them to GeoprocessingParameters::inputs, where key is the name of the parameter and value is the created parameter.
- Set environmental variables on GeoprocessingParameters if needed, such as GeoprocessingParameters::returnZ or GeoprocessingParameters::outputSpatialReference.
- Create a GeoprocessingJob with createJob.
- Start listening for status and message changes using the GeoprocessingJob::jobStatusChanged signal.
- Run the targeted geoprocessing task using GeoprocessingJob::start which sets GeoprocessingResult when finished.
- Handle returned values accordingly. Access output parameters through GeoprocessingResult::outputs dictionary where key is the name of the output parameter and the value is the returned parameter. If used geoprocessing service is configured to use result map service, GeoprocessingResult::mapImageLayer might be created for you.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| Credential | credential (since Esri.ArcGISRuntime 100.1) |
| RequestConfiguration | requestConfiguration (since Esri.ArcGISRuntime 100.1) |
See also Loadable, RemoteResource, and Cancelable.
Property Documentation
createDefaultParametersResult : GeoprocessingParameters |
Results from createDefaultParameters(), giving access to the default GeoprocessingParameters (read-only).
Obtain this property after the createDefaultParametersStatusChanged signal emits, and the createDefaultParametersStatus is complete.
This property was introduced in Esri.ArcGISRuntime 100.1.
Returns the current status of the createDefaultParameters method (read-only).
Wait until the createDefaultParametersStatus is Enums.TaskStatusComplete before obtaining the createDefaultParametersResult.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Enums.TaskStatus.
[default] credential : Credential |
The credential to be used for a secured online geoprocessing service.
This property was introduced in Esri.ArcGISRuntime 100.1.
error : Error |
geoprocessingTaskInfo : GeoprocessingTaskInfo |
The GeoprocessingTaskInfo of this GeoprocessingTask.
This property was introduced in Esri.ArcGISRuntime 100.1.
loadError : Error |
Returns the load error (read-only).
Note: load errors are also reported on the error property and emit the errorChanged signal.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.
Returns the load status (read-only).
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable and Enums.LoadStatus.
[default] requestConfiguration : RequestConfiguration |
The configuration parameters used for network requests sent by this task.
This property was introduced in Esri.ArcGISRuntime 100.1.
The URL of this GeoprocessingTask.
This property was introduced in Esri.ArcGISRuntime 100.0.
Signal Documentation
Emitted when the createDefaultParametersStatus property changes.
Note: The corresponding handler is onCreateDefaultParametersStatusChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the credential property changes.
Note: The corresponding handler is onCredentialChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
The signal emitted when the geoprocessingTaskInfo property changes.
Note: The corresponding handler is onGeoprocessingTaskInfoChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the loadError property of this GeoprocessingTask changes.
Note: load errors are also reported on the error property and emit the errorChanged signal.
Note: The corresponding handler is onLoadErrorChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the loadStatus property of this GeoprocessingTask changes.
Note: The corresponding handler is onLoadStatusChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.
Emitted when the requestConfiguration property changes.
Note: The corresponding handler is onRequestConfigurationChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
The signal emitted when the url property changes.
Note: The corresponding handler is onUrlChanged.
This signal was introduced in Esri.ArcGISRuntime 100.0.
Method Documentation
Cancel the task with the ID taskId.
Returns false if the task cannot be canceled or there is no task with the specified id taskId.
This method was introduced in Esri.ArcGISRuntime 100.1.
See also Cancelable.
Creates default geoprocessing parameters from the service.
The createDefaultParametersStatusChanged signal will emit once the operation is complete, giving access to the createDefaultParametersResult.
This method was introduced in Esri.ArcGISRuntime 100.1.
GeoprocessingParameters createDefaultParametersResult() |
The resulting parameters created by the async createDefaultParameters method.
This method was introduced in Esri.ArcGISRuntime 100.1.
GeoprocessingJob createJob(GeoprocessingParameters parameters) |
Creates and returns a GeoprocessingJob populated with a set of task parameters.