jobs

Types

BulkProgress

extends JobProgress
since 2.0

Default implementation for bulk jobs.

Field Name Type Required Default Since Description
remaining NonNegativeInteger (int) yes - 2.0 Specifies how many requests have still to be calculated.
successful NonNegativeInteger (int) yes - 2.0 The number of successful calculations so far.
failed NonNegativeInteger (int) yes - 2.0 The number of failed computations so far.

Job

since 2.0

Reference to jobs running in the background.

Field Name Type Required Default Since Description
id String yes - 2.0 Reference to jobs running in the background.
status JobStatus yes - 2.0 The current status of the job.
progress JobProgress no - 2.0 The current progress of the job. Can be null at the very beginning or very end of the request execution.
elapsedTime Milliseconds (int) yes - 2.0 Elapsed time since this job has been queued.

JobProgress (abstract)

extended by DistanceMatrixProgress, BulkProgress, ClusterPlanningProgress, HighPerformanceRoutingNetworkProgress, TourPlanProgress
used by Job
since 2.0

Abstract base type for progresses.

No fields defined.

JobRequest

since 2.0

Request for stopping and deleting jobs.

Field Name Type Required Default Since Description
id String yes - 2.0 The job's ID.

WatchRequest

since 2.0

This type contains parameters to watch the progress of a job using watchJob. If the job is already finished, watchJob will return immediately. As long as the job is still running watchJob will return only after the next available progress update. See the technical concept for details.

Field Name Type Required Default Since Description
id String yes - 2.0 The job's ID.
progressUpdatePeriod Milliseconds (Integer) no 1000 2.0 As long as the job is running watchJob will not return before this progressUpdatePeriod has elapsed. It will return immediately if the job terminates during that period. Use this parameter to control the frequency of progress updates or to ignore them for the given period. The range is limited to 250ms minimum and 50000ms maximum. Values less than 250ms will be set to 250ms and values greater than 50000ms will be set to 50000ms.
maximumPollingPeriod Milliseconds (Integer) no 50000 2.0 Specifies the maximum period after which watchJob will report the last status even if no further progress updates are available. This applies only to running jobs and if the respective service does not provide progress updates at all or at least not for a longer period.
Enumeration

JobStatus

used by Job, Request
since 2.0

Specifies different job status values.

Enumeration Value Since Description
QUEUING 2.0 Job has been enqueued.
RUNNING 2.0 Job is currently running.
STOPPING 2.0 Stop has been requested, the job will terminate its calculation as soon as possible.
SUCCEEDED 2.0 Job has completed successfully.
FAILED 2.0 Job has failed with an exception.
DELETED 2.0 The job was deleted by the user.
UNKNOWN 2.0 The job is in an unknown state. For example a given ID is unknown or the job has already been fetched and has therefore been deleted from the underlying persistent store.

Diagrams

Jobs