require(["esri/networks/support/TraceJobInfo"], (TraceJobInfo) => { /* code goes here */ });
import TraceJobInfo from "@arcgis/core/networks/support/TraceJobInfo.js";
esri/networks/support/TraceJobInfo
Represents information pertaining to the execution of an asynchronous request on the server.
- See also
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 |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| Date | The last date and time the service was updated. | TraceJobInfo | |
| String | The job status. | TraceJobInfo | |
| String | ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request. | TraceJobInfo | |
| Date | The date and time in which submitTopologyValidationJob() is first called. | TraceJobInfo |
Property Details
-
lastUpdatedTime
PropertylastUpdatedTime Date -
The last date and time the service was updated.
-
status
Propertystatus String -
The job status.
Possible Values:"pending"|"in-progress"|"completed"
-
statusUrl
PropertystatusUrl String -
ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request.
-
submissionTime
PropertysubmissionTime 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 | ||
| Promise<TraceJobInfo> | Sends a request for the current state of this job. | TraceJobInfo | |
Stop monitoring this job for status updates. | TraceJobInfo | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TraceJobInfo | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | TraceJobInfo | |
| Promise<TraceJobInfo> | Resolves when an asynchronous job has completed. | TraceJobInfo |
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
MethodcheckJobStatus(requestOptions){Promise<TraceJobInfo>} -
Sends a request for the current state of this job.
ParameterrequestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
ReturnsType Description Promise<TraceJobInfo> When resolved, returns a TraceJobInfo. Exampleconst traceLocation = TraceLocation.fromJSON({ traceLocationType: "startingPoint", globalId: "{BBF88249-6BAD-438F-9DBB-0E48DD89EECA}", percentAlong: 0.5805425412252266 }); const traceParameters = TraceParameters.fromJSON({ traceConfigurationGlobalId: "{DF22DA8D-6EC0-408B-A8B2-E468EC7DC9BF}", resultTypes: [ { type: "elements", includeGeometry: false, includePropagatedValues: false, networkAttributeNames: [], diagramTemplateName: "", resultTypeFields: [] }, { type: "aggregatedGeometry", includeGeometry: false, includePropagatedValues: false, networkAttributeNames: [], diagramTemplateName: "", resultTypeFields: [] } ], traceType: "subnetwork" }); traceParameters.traceLocations = [traceLocation]; const jobInfo = await network.submitTraceJob(traceParameters); await jobInfo.checkJobStatus();
-
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
jsonparameter 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 trueif 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
MethodtoJSON(){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
MethodwaitForJobCompletion(options){Promise<TraceJobInfo>} -
Resolves when an asynchronous job has completed. Optionally job progress can be monitored.
ParametersSpecificationoptions ObjectoptionalOptions. See properties below for object specifications.
Specificationinterval ObjectoptionalDefault 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 ObjectoptionalCallback function that is called at the specified interval. Use this method to monitor job status and messages.
ReturnsType Description Promise<TraceJobInfo> When resolved, returns a TraceJobInfo. Example// Submit an asynchronous trace job. const traceLocation: TraceLocation = TraceLocation.fromJSON({ traceLocationType: "startingPoint", globalId: "{BBF88249-6BAD-438F-9DBB-0E48DD89EECA}", percentAlong: 0.5805425412252266 }); const traceParameters: TraceParameters = TraceParameters.fromJSON({ traceConfigurationGlobalId: "{DF22DA8D-6EC0-408B-A8B2-E468EC7DC9BF}", moment: 1554214441244, gdbVersion: "SDE.DEFAULT", resultTypes: [ { type: "elements", includeGeometry: false, includePropagatedValues: false, networkAttributeNames: [], diagramTemplateName: "", resultTypeFields: [] }, { type: "aggregatedGeometry", includeGeometry: false, includePropagatedValues: false, networkAttributeNames: [], diagramTemplateName: "", resultTypeFields: [] } ], traceType: "subnetwork" }); traceParameters.traceLocations = [traceLocation]; const jobInfo = await network.submitTraceJob(traceParameters); await jobInfo.waitForJobCompletion();