JobInfo

属性列表

属性详细说明

declaredClass Stringreadonly inherited

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

jobId String

GeoScene Server 分配的唯一作业 ID。

jobStatus String

作业状态。

可选值:"job-cancelled"|"job-cancelling"|"job-deleted"|"job-deleting"|"job-timed-out"|"job-executing"|"job-failed"|"job-new"|"job-submitted"|"job-succeeded"|"job-waiting"

messages GPMessage[]

包含消息类型和描述的消息数组。

requestOptions Object

用于数据请求的选项。这些选项也可以通过requestOptions方法参数来控制。

sourceUrl String

接收地理处理请求的资源的 GeoScene Server Rest API 端。

方法列表

方法详细说明

cancelJob(jobId, requestOptions){Promise<JobInfo>}

取消异步地理处理作业。需要 GeoScene Server 2.0 服务或更高版本。

参数:

jobId String 唯一标识服务器上的作业的字符串。它在提交作业以供执行时创建，并在之后用于检查其状态并检索结果。

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

返回值:

类型	描述
Promise<JobInfo>	解析后，返回 JobInfo.

checkJobStatus(requestOptions){Promise<JobInfo>}

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

参数:

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

返回值:

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

destroy()

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

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

示例:

• jobInfo.waitForJobCompletion()

fetchResultData(resultName, gpOptions, requestOptions){Promise<ParameterValue>}

向 GP 任务发送请求以获取由 resultName 标识的任务结果。

参数:

resultName String 服务目录中定义的结果参数的名称。

gpOptions GPOptions optional 地理处理服务返回值的输入选项。

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

返回值:

类型	描述
Promise<ParameterValue>	解析后，返回一个具有名为 result 的 ParameterValue类型的对象，其中包含结果参数和任务执行消息。

fetchResultImage(jobId, resultName, imageParams, requestOptions){Promise<ParameterValue>}

向GP任务发送请求，以获取由 jobId 和resultName 标识为图像的任务结果。

参数:

jobId String 从JobInfo返回的 jobId 。

resultName String 服务目录中定义的结果参数的名称。

imageParams ImageParameters 指定得到的结果图像的属性。

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

返回值:

类型	描述
Promise<ParameterValue>	解析后，返回 mapImage 属性类型为 MapImage 的对象。

fetchResultMapImageLayer(jobId){Promise<MapImageLayer>}

获取由 jobId 标识为 MapImageLayer 的任务结果。

参数:

jobId String 从JobInfo返回的 jobId 。

返回值:

类型	描述
Promise<MapImageLayer>	解析为 MapImageLayer 实例的承诺。

示例代码:

// Get the resulting map image layer from a completed geoprocessing job.
jobInfo.fetchResultMapImageLayer(jobInfo.jobId)).then(function(layer){
  view.map.add(layer);
});

fromJSON(json){*}static

创建此类的新实例，并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。传递给输入 json 参数的对象通常来自对 REST API 中的查询操作的响应，或者来自另一个 GeoScene产品的 toJSON() 方法。有关何时以及如何使用此函数的详细信息和示例，请参阅指南中的 使用 fromJSON() 主题。

参数:

json Object 实例的 json 表达式，以geoscene 格式显示。

返回值:

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

toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息，请参阅 使用 fromJSON() 指南。

返回值:

类型	描述
Object	此类实例的 GeoScene portal JSON 格式。

waitForJobCompletion(options){Promise<JobInfo>}

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

参数:

规范:

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

返回值:

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

示例代码:

// Submit an asynchronous geoprocessing job. Display the remote job status every 1.5 seconds.
// When the job has completed at the output as a MapImageLayer.
const startDate = "1998-01-01 00:00:00";
constendDate = "1998-05-31 00:00:00";
const params = {
  query: "(Date >= date '" + startDate + "' and Date <= date '" + endDate + "')"
};

const url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/911CallsHotspot/GPServer/911%20Calls%20Hotspot";

submitJob(url, params).then((jobInfo) => {
  const jobid = jobInfo.jobId;

  const options = {
    interval: 1500,
    statusCallback: (j) => {
      console.log("Job Status: ", j.jobStatus);
    }
  };

  jobInfo.waitForJobCompletion(options).then(() => {
    const layer = jobInfo.fetchResultMapImageLayer();
    map.add(layer);
  });
});