TopologyValidationJobInfo

Property Overview

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

lastUpdatedTime Date

The last date and time the service was updated.

status String

The job status.

Possible Values:"pending"|"in-progress"|"completed"

statusUrl String

ArcGIS Server Rest API endpoint to the resource that receives the validate network topology request.

submissionTime Date

The date and time in which submitTopologyValidationJob() is first called.

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

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();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key 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(requestOptions){Promise<TopologyValidationJobInfo>}

Sends a request for the current state of this job.

Parameter

requestOptions Object optional Additional options to be used for the data request (will override requestOptions defined during construction).

Returns

Type	Description
Promise<TopologyValidationJobInfo>	When resolved, returns a TopologyValidationJobInfo.

Example

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 jobInfo = await result.checkJobStatus();
console.log("jobInfo.status", jobInfo.status);

destroy()

Stop monitoring this job for status updates.

// Stop monitoring this job for status updates.
jobInfo.destroy();

See also

• topologyValidationJobInfo.waitForJobCompletion()

fromJSON(json){*}static

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.

Parameter

json Object A 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.

Returns

Type	Description
*	Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	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");
}

removeHandles(groupKey)inherited

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

waitForJobCompletion(options){Promise<TopologyValidationJobInfo>}

Resolves when an asynchronous job has completed. Optionally job progress can be monitored.

Parameters

Specification

options Object optional Options. See properties below for object specifications. Specification interval Object optional Default Value: 1000 The time in millisecond between remote job status requests. signal Object optional AbortSignal allows for cancelable asynchronous job. If canceled, the promise will be rejected with an error named AbortError. statusCallback Object optional Callback function that is called at the specified interval. Use this method to monitor job status and messages.

Returns

Type	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);