require(["esri/networks/support/TopologyValidationJobInfo"], (TopologyValidationJobInfo) => { /* code goes here */ });
import TopologyValidationJobInfo from "@arcgis/core/networks/support/TopologyValidationJobInfo.js";
esri/networks/support/TopologyValidationJobInfo
Represents information pertaining to the execution of an asynchronous submitTopologyValidationJob() request on the server.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The last date and time the service was updated. | TopologyValidationJobInfo | ||
The job status. | TopologyValidationJobInfo | ||
ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request. | TopologyValidationJobInfo | ||
The date and time in which submitTopologyValidationJob() is first called. | TopologyValidationJobInfo |
Property Details
-
lastUpdatedTime
lastUpdatedTime Date
-
The last date and time the service was updated.
-
status
status String
-
The job status.
Possible Values:"job-waiting" |"job-executing" |"job-succeeded"
-
statusUrl
statusUrl String
-
ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request.
-
submissionTime
submissionTime Date
-
The date and time in which submitTopologyValidationJob() is first called.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Sends a request for the current state of this job. | TopologyValidationJobInfo | ||
Stop monitoring this job for status updates. | TopologyValidationJobInfo | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TopologyValidationJobInfo | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | TopologyValidationJobInfo | ||
Resolves when an asynchronous job has completed. | TopologyValidationJobInfo |
Method Details
-
Inherited from Accessor
-
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.
-
checkJobStatus
checkJobStatus(requestOptions){Promise<TopologyValidationJobInfo>}
-
Sends a request for the current state of this job.
ParameterReturnsType Description Promise<TopologyValidationJobInfo> When resolved, returns a TopologyValidationJobInfo. Exampleconst extent = new Extent({ xmin: 470789.0888, ymin: 3597733.2051, xmax: 531454.2759999996, ymax: 3639864.802100001, spatialReference: { wkid: 26911, latestWkid: 26911 } }); const result = await network.submitTopologyValidationJob( new ValidateNetworkTopologyParameters({ validateArea: extent, gdbVersion: "version.test" }) ); const jobInfo = await result.checkJobStatus(); console.log("jobInfo.status", jobInfo.status);
-
Stop monitoring this job for status updates.
// Stop monitoring this job for status updates. jobInfo.destroy();
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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"); }
-
Inherited from Accessor
-
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
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.
-
waitForJobCompletion
waitForJobCompletion(options){Promise<TopologyValidationJobInfo>}
-
Resolves when an asynchronous job has completed. Optionally job progress can be monitored.
ParametersSpecificationoptions ObjectoptionalOptions. See properties below for object specifications.
Specificationinterval NumberoptionalDefault 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 FunctionoptionalCallback function that is called at the specified interval. Use this method to monitor job status and messages.
ReturnsType Description Promise<TopologyValidationJobInfo> When resolved, returns a TopologyValidationJobInfo. Example// Submit an asynchronous validate network topology job. Display the remote job status every 1.5 seconds. const extent = new Extent({ xmin: 470789.0888, ymin: 3597733.2051, xmax: 531454.2759999996, ymax: 3639864.802100001, spatialReference: { wkid: 26911, latestWkid: 26911 } }); const result = await network.submitTopologyValidationJob( new ValidateNetworkTopologyParameters({ validateArea: extent, gdbVersion: "version.test" }) ); const options = { interval: 1500, statusCallback: (j) => { console.log("Job Status: ", j.jobStatus); } }; await jobInfo.waitForJobCompletion(options);