Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JobInfo

Hierarchy

Index

Properties

Methods

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

jobId

jobId: string

The unique job ID assigned by ArcGIS Server.

Read more...

jobStatus

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

The job status.

Read more...

messages

messages: supportGPMessage[]

An array of messages that include the message type and a description.

Read more...

requestOptions

requestOptions: any

The options to be used for data requests.

Read more...

sourceUrl

sourceUrl: string

ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T

  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): JobInfo

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns JobInfo

cancelJob

  • cancelJob(jobId: string, requestOptions?: any): Promise<JobInfo>

  • Cancels an asynchronous geoprocessing job.

    Read more...

    Parameters

    • jobId: string
    • Optional requestOptions: any

    Returns Promise<JobInfo>

destroy

  • destroy(): void

  • Returns void

fetchResultData

  • fetchResultData(jobId: string, resultName: string, requestOptions?: any): Promise<ParameterValue>

  • Sends a request to the GP Task to get the task result identified by jobId and resultName.

    Read more...

    Parameters

    • jobId: string
    • resultName: string
    • Optional requestOptions: any

    Returns Promise<ParameterValue>

fetchResultImage

  • Sends a request to the GP Task to get the task result identified by jobId and resultName as an image.

    Read more...

    Parameters

    • jobId: string
    • resultName: string
    • imageParams: ImageParameters
    • Optional requestOptions: any

    Returns Promise<ParameterValue>

fetchResultMapImageLayer

  • fetchResultMapImageLayer(jobId: string): Promise<MapImageLayer>

  • Get the task result identified by jobId as an MapImageLayer.

    Read more...

    Parameters

    • jobId: string

    Returns Promise<MapImageLayer>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void

  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns JobInfo

  • Parameters

    Returns JobInfo

toJSON

  • toJSON(): any

  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc