TopologyValidationJobInfo | References | ArcGIS Maps SDK for JavaScript

import TopologyValidationJobInfo from "@arcgis/core/networks/support/TopologyValidationJobInfo.js";

Inheritance:: TopologyValidationJobInfo→ValidateNetworkTopologyResult→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.26

Represents information pertaining to the execution of an asynchronous Network.submitTopologyValidationJob() request on the server.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`TopologyValidationJobInfoProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`discoveredSubnetworks` inherited	`Subnetwork[] \| null \| undefined`	ValidateNetworkTopologyResult
`exceededTransferLimit` inherited	`boolean \| null \| undefined`	ValidateNetworkTopologyResult
`fullUpdate` inherited	`boolean`	ValidateNetworkTopologyResult
`lastUpdatedTime`	`Date \| null \| undefined`
`moment` inherited	`Date \| null \| undefined`	ValidateNetworkTopologyResult
`serviceEdits` inherited	`ValidateServiceEdits[] \| null \| undefined`	ValidateNetworkTopologyResult
`status`	`TopologyValidationJobStatus`
`statusUrl`	`string`
`submissionTime`	`Date \| null \| undefined`
`validateErrorsCreated` inherited	`boolean`	ValidateNetworkTopologyResult

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

discoveredSubnetworks

inherited Property

Type: Subnetwork[] | null | undefined

Inherited from: ValidateNetworkTopologyResult

Contains information about the subnetworks that are marked as dirty during the validation process, along with the domain network and tier containing the subnetwork.

exceededTransferLimit

inherited Property

Type: boolean | null | undefined

Inherited from: ValidateNetworkTopologyResult

If maxRecordCount is configured for a layer, exceededTransferLimit will be true if a query matches more than the maxRecordCount features. It will be false otherwise.

fullUpdate

inherited Property

Type: boolean

Inherited from: ValidateNetworkTopologyResult

If the current feature service contains no dirty areas, full update will return true.

Default value: false

lastUpdatedTime

autocast Property

Type: Date | null | undefined

The last date and time the service was updated.

moment

autocast inherited Property

Type: Date | null | undefined

Inherited from: ValidateNetworkTopologyResult

The date/timestamp (in UTC) when the validate process was executed.

serviceEdits

inherited Property

Type: ValidateServiceEdits[] | null | undefined

Inherited from: ValidateNetworkTopologyResult

The serviceEdits returns full features including the original features prior to delete, the original and current features for updates, and the current rows for inserts, which may contain implicit changes.

status

Property

Type: TopologyValidationJobStatus

The job status.

statusUrl

Property

Type: string

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

submissionTime

autocast Property

Type: Date | null | undefined

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

validateErrorsCreated

inherited Property

Type: boolean

Inherited from: ValidateNetworkTopologyResult

If error features are created during the validation process validateErrorsCreated will be true.

Default value: false

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`checkJobStatus`	`checkJobStatus(requestOptions?: RequestOptions \| null): Promise<TopologyValidationJobInfo>`
`destroy`	`destroy(): void`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin
`waitForJobCompletion`	`waitForJobCompletion(options?: WaitForValidateOptions): Promise<TopologyValidationJobInfo>`

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

checkJobStatus

Method

Signature: checkJobStatus (requestOptions?: RequestOptions | null): Promise<TopologyValidationJobInfo>

Sends a request for the current state of this job.

Parameters

Parameter	Type	Description	Required
requestOptions	`RequestOptions \| null`	Additional options to be used for the data request (will override requestOptions defined during construction).

Returns: 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

Method

Signature: destroy (): void

Stop monitoring this job for status updates.

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

See also

waitForJobCompletion()

Returns: void

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

waitForJobCompletion

Method

Signature: waitForJobCompletion (options?: WaitForValidateOptions): Promise<TopologyValidationJobInfo>

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

Parameters

Parameter	Type	Description	Required
options	`WaitForValidateOptions`	Options. See properties below for object specifications.

Returns: 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);

Type definitions

TopologyValidationJobStatus

Type definition

Type: "job-waiting" | "job-executing" | "job-succeeded"

WaitForValidateOptions

Type definition

interval

Property

Type: number | undefined

The time in millisecond between remote job status requests.

Default value: 1000

statusCallback

Property

Type: (result: TopologyValidationJobInfo) => void | undefined

Callback function that is called at the specified interval. Use this method to monitor job status and messages.