Skip to content

Interface

Describes the status of a job. See the GP Job documentation for more information.

Properties

PropertyTypeNotes
idstring

The ID of the job. Can be used to rehydrate an instance of Job with Job.fromExistingJob or Job.deserialize.

inputs{ [key: string]: { paramUrl: string } }

An input property that are returned from a successful job.

messages{ description: string; type: string }[]

A message property that are returned from a successful job.

progress{ message: string; percentage: number; type: string }

A progress property that is returned while the job status is JOB_STATUSES.Executing

results{ [key: string]: { paramUrl: string } }

A results property that are returned from a successful job.

statusJOB_STATUSES

Represents the status of the current job.

id

Interface Property

inputs

optional
Interface Property

messages

optional
Interface Property

progress

optional
Interface Property

results

optional
Interface Property

status

Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.