TraceJobInfo | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Represents information pertaining to the execution of an asynchronous request on the server.

See also

Constructors

TraceJobInfo Constructor new TraceJobInfo(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
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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

lastUpdatedTime Property lastUpdatedTime Date

The last date and time the service was updated.

status Property status String

The job status.

Possible Values:"job-waiting" |"job-executing" |"job-succeeded"

statusUrl Property statusUrl String

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

submissionTime Property submissionTime Date

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

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

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.

checkJobStatus Method checkJobStatus(requestOptions){Promise<TraceJobInfo>}

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<TraceJobInfo>	When resolved, returns a TraceJobInfo.

Example

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

destroy Method destroy()

Stop monitoring this job for status updates.

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

See also

topologyValidationJobInfo.waitForJobCompletion()

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.

waitForJobCompletion Method waitForJobCompletion(options){Promise<TraceJobInfo>}

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