GeoprocessingTask QML Type

  • Esri.ArcGISRuntime
  • GeoprocessingTask
  • GeoprocessingTask is used to run a geoprocessing task that is published as a web service. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0
    Inherits:

    Object

    Properties

    Signals

    Methods

    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.

    1. Create a GeoprocessingTask using the full URL to the target geoprocessing task endpoint.
    2. Create a GeoprocessingParameters providing corresponding Enums.GeoprocessingExecutionType.
    3. Create the necessary GeoprocessingParameters and add them to GeoprocessingParameters::inputs, where key is the name of the parameter and value is the created parameter.
    4. Set environmental variables on GeoprocessingParameters if needed, such as GeoprocessingParameters::returnZ or GeoprocessingParameters::outputSpatialReference.
    5. Create a GeoprocessingJob with createJob.
    6. Start listening for status and message changes using the GeoprocessingJob::statusChanged signal.
    7. Run the targeted geoprocessing task using GeoprocessingJob::start which sets GeoprocessingResult when finished.
    8. 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.

    TypeDefault Property
    Credentialcredential (since Esri.ArcGISRuntime 100.1)
    RequestConfigurationrequestConfiguration (since Esri.ArcGISRuntime 100.1)

    See also Loadable, RemoteResource, and Cancelable.

    Property Documentation

    [read-only, since Esri.ArcGISRuntime 100.1] 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.


    [read-only, since Esri.ArcGISRuntime 100.1] createDefaultParametersStatus : Enums.TaskStatus

    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, since Esri.ArcGISRuntime 100.1] credential : Credential

    The credential to be used for a secured online geoprocessing service.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [read-only, since Esri.ArcGISRuntime 100.1] error : Error

    Returns the error object (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.1.

    See also Loadable and Error.


    [read-only, since Esri.ArcGISRuntime 100.1] geoprocessingTaskInfo : GeoprocessingTaskInfo

    The GeoprocessingTaskInfo of this GeoprocessingTask.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [read-only, since 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.


    [read-only, since Esri.ArcGISRuntime 100.1] loadStatus : Enums.LoadStatus

    Returns the load status (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.1.

    See also Loadable and Enums.LoadStatus.


    [default, since Esri.ArcGISRuntime 100.1] requestConfiguration : RequestConfiguration

    The configuration parameters used for network requests sent by this task.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.0] url : url

    The URL of this GeoprocessingTask.

    This property was introduced in Esri.ArcGISRuntime 100.0.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.1] createDefaultParametersStatusChanged()

    Emitted when the createDefaultParametersStatus property changes.

    Note: The corresponding handler is onCreateDefaultParametersStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.1] credentialChanged()

    Emitted when the credential property changes.

    Note: The corresponding handler is onCredentialChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.1] geoprocessingTaskInfoChanged()

    The signal emitted when the geoprocessingTaskInfo property changes.

    Note: The corresponding handler is onGeoprocessingTaskInfoChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.1] loadErrorChanged()

    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.

    See also Loadable and Object.


    [since Esri.ArcGISRuntime 100.1] loadStatusChanged()

    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.


    [since Esri.ArcGISRuntime 100.1] requestConfigurationChanged()

    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.0] urlChanged()

    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

    [since Esri.ArcGISRuntime 100.1] void cancelLoad()

    See Loadable

    This method was introduced in Esri.ArcGISRuntime 100.1.

    See also Loadable.


    [since Esri.ArcGISRuntime 100.1] bool cancelTask(string taskId)

    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.


    [since Esri.ArcGISRuntime 100.1] string createDefaultParameters()

    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.


    [since Esri.ArcGISRuntime 100.1] GeoprocessingParameters createDefaultParametersResult()

    The resulting parameters created by the async createDefaultParameters method.

    This method was introduced in Esri.ArcGISRuntime 100.1.


    Creates and returns a GeoprocessingJob populated with a set of task parameters.


    [since Esri.ArcGISRuntime 100.1] void load()

    See Loadable

    This method was introduced in Esri.ArcGISRuntime 100.1.

    See also Loadable.


    [since Esri.ArcGISRuntime 100.1] void retryLoad()

    See Loadable

    This method was introduced in Esri.ArcGISRuntime 100.1.

    See also Loadable.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.