Interface supportJobInfo

Hierarchy

Accessor
JSONSupport
- supportJobInfo

Index

Properties

Methods

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

jobId

jobId: string

The unique job ID assigned by ArcGIS Server.

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.

messages

messages: supportGPMessage[]

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

requestOptions

requestOptions: any

The options to be used for data requests.

sourceUrl

sourceUrl: string

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

Methods

Protected _get

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

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): supportJobInfo

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns supportJobInfo

cancelJob

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

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37130
Cancels an asynchronous geoprocessing job.

Read more...

Parameters
- jobId: string
- Optional requestOptions: any
Returns Promise<supportJobInfo>

checkJobStatus

checkJobStatus(requestOptions?: any): Promise<supportJobInfo>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37136
Sends a request for the current state of this job.

Read more...

Parameters
- Optional requestOptions: any
Returns Promise<supportJobInfo>

destroy

destroy(): void

Overrides Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37142
Stop monitoring this job for status updates.

Read more...

Returns void

fetchResultData

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

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37148
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<supportParameterValue>

fetchResultImage

fetchResultImage(jobId: string, resultName: string, imageParams: ImageParameters, requestOptions?: any): Promise<supportParameterValue>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37154
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<supportParameterValue>

fetchResultMapImageLayer

fetchResultMapImageLayer(jobId: string): Promise<MapImageLayer>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37165
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

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

set

set<T>(propertyName: string, value: T): supportJobInfo
set(props: HashMap<any>): supportJobInfo

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns supportJobInfo
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns supportJobInfo

toJSON

toJSON(): any

Inherited from JSONSupport.toJSON
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1214
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any

waitForJobCompletion

waitForJobCompletion(options?: JobInfoWaitForJobCompletionOptions): Promise<supportJobInfo>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37171
Resolves when an asynchronous job has completed.

Read more...

Parameters
- Optional options: JobInfoWaitForJobCompletionOptions
Returns Promise<supportJobInfo>

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Generated using TypeDoc