ValidateNetworkTopologyParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

ValidateNetworkTopologyParameters Constructor new ValidateNetworkTopologyParameters(properties)

Parameter

properties Object

optional

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

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String	Specifies the geodatabase version name.	ValidateNetworkTopologyParameters
SpatialReference	The spatial reference of the returned geometry.	ValidateNetworkTopologyParameters
String	Specifies the GUID used to lock the version.	ValidateNetworkTopologyParameters
Extent	Specifies the envelope of the area to validate.	ValidateNetworkTopologyParameters
ValidationSetItemJSON []	Specifies the set of features and objects to validate.	ValidateNetworkTopologyParameters
String	Specifies the validation to perform.	ValidateNetworkTopologyParameters

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

gdbVersion Property gdbVersion String

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

outSpatialReference Property outSpatialReference SpatialReference

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

sessionID Property sessionID String

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 Property validateArea Extent

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

validationSet Property validationSet ValidationSetItemJSON[]

Specifies the set of features and objects to validate.

Note

This parameter is available at ArcGIS Enterprise 10.9.

validationType Property validationType String

Specifies the validation to perform.

Possible Values:"normal" |"rebuild" |"force-rebuild"

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	ValidateNetworkTopologyParameters
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.	ValidateNetworkTopologyParameters

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) 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();

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.

fromJSON Method 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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 Inherited Method removeHandles(groupKey) Inherited from Accessor

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 Method 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.

Type Definitions

ValidationSetItemJSON Type Definition ValidationSetItemJSON Object

ValidationSetItemJSON represents the set of features and objects to validate.

Properties: sourceId Number

The network source id of the.

globalIds String []

An array of globalId strings to validate.

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