TraceJobInfo

属性概述

属性详细信息

declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className。

lastUpdatedTime Date

上次更新服务的日期和时间。

status String

作业状态。

可能值："pending"|"in-progress"|"completed"

statusUrl String

接收验证网络拓扑请求的资源的 GeoScene Server Rest API 端点。

submissionTime Date

首次调用 submitTopologyValidationJob() 的日期和时间。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

checkJobStatus(requestOptions){Promise<TraceJobInfo>}

发送对该作业当前状态的请求。

参数

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

类型	描述
Promise<TraceJobInfo>	解析后，返回 TraceJobInfo。

示例

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

停止监视此作业的状态更新。

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

另请参阅

• topologyValidationJobInfo.waitForJobCompletion()

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数

json Object GeoScene 格式实例的 JSON 表示。

返回

类型	描述
*	返回该类的新实例。

hasHandles(groupKey){Boolean}inherited

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

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

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

toJSON(){Object}

将此类的实例转换为其 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。

waitForJobCompletion(options){Promise<TraceJobInfo>}

在异步作业完成时解析。可以选择监控作业进度。

参数

规范

options Object optional 选项。有关对象规范，请参阅以下属性。 规范 interval Object optional 默认值：1000 远程作业状态请求之间的时间 (以毫秒为单位)。 signal Object optional AbortSignal 允许取消异步作业。如果取消，则 promise 将被拒绝，并返回一个名为 AbortError 的错误。 statusCallback Object optional 以指定间隔调用的回调函数。使用此方法监控作业状态和消息。

返回

类型	描述
Promise<TraceJobInfo>	解析后，返回 TraceJobInfo。

示例

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