ValidateNetworkTopologyParameters | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ValidateNetworkTopologyParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.26

ValidateNetworkTopologyParameters describes the optional and required parameters for validating a network topology. Optional parameters include gdbVersion, sessionID, validationType, and validationSet. The only required property is validateArea.

See also

Example

const validationResult = await network.submitTopologyValidationJob(
  new ValidateNetworkTopologyParameters({
    validateArea: extent,
    gdbVersion: "sde.DEFAULT",
    validationType: "rebuild",
    sessionID: "{7865BAA6-ED9C-4346-9F72-894A49E10C73}",
    validationSet: [
      {
        sourceId: 4134325151,
        globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"]
      }
    ]
  })
);

console.log("result: ", validationResult);

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ValidateNetworkTopologyParametersProperties`

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
`gdbVersion`	`string \| null \| undefined`
`outSpatialReference`	`SpatialReference \| null \| undefined`
`sessionID`	`string \| null \| undefined`
`validateArea`	`Extent`
`validationSet`	`ValidationSetItemJSON[] \| null \| undefined`
`validationType`	`ValidationType \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

gdbVersion

Property

Type: string | null | undefined

Specifies the geodatabase version name. Defaults to SDE.DEFAULT when no version is provided.

outSpatialReference

autocast Property

Type: SpatialReference | null | undefined

The spatial reference of the returned geometry. If not specified, the geometry is returned in the spatial reference of the feature service.

sessionID

Property

Type: string | null | undefined

Specifies the GUID used to lock the version. If the client is editing SDE.DEFAULT, the sessionID should not be used because this version cannot be locked.

validateArea

autocast Property

Type: Extent

Specifies the envelope of the area to validate. This property is required.

validationSet

Property

Type: ValidationSetItemJSON[] | null | undefined

Specifies the set of features and objects to validate.

Note

This parameter is available at ArcGIS Enterprise 10.9.

validationType

Property

Type: ValidationType | null | undefined

Specifies the validation to perform.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

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.

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.