TourRouteOptimizationJob

GraphHopper route optimization of the tours a tour plan generation estimated, over its date range.

type TourRouteOptimizationJob implements Job {
  createdAt: DateTime!
  endDate: Date!
  error: JobError
  finishedAt: DateTime
  id: JobID!
  operation: String!
  progress: JobProgress
  requestedBy: Employee
  requeuedFrom: Job
  residentialParkId: ResidentialParkID!
  startDate: Date!
  startedAt: DateTime
  status: JobStatus!
  warnings: [JobWarning!]!
}

Fields

TourRouteOptimizationJob.createdAt ● DateTime! non-null scalar

When the job was accepted.

TourRouteOptimizationJob.endDate ● Date! non-null scalar

The last day of the range, inclusive.

TourRouteOptimizationJob.error ● JobError object

Why the job failed. Set only when status is FAILED.

TourRouteOptimizationJob.finishedAt ● DateTime scalar

When the job reached a terminal state.

TourRouteOptimizationJob.id ● JobID! non-null scalar

Unique identifier, also the support reference of a failure.

TourRouteOptimizationJob.operation ● String! non-null scalar

The GraphQL operation that submitted the job.

TourRouteOptimizationJob.progress ● JobProgress object

Progress while the job runs: days routed of days in the range.

TourRouteOptimizationJob.requestedBy ● Employee object

The employee who triggered the job. Null for API keys and system triggers.

TourRouteOptimizationJob.requeuedFrom ● Job interface

The job this one re-runs, when it was created by requeueJob.

TourRouteOptimizationJob.residentialParkId ● ResidentialParkID! non-null scalar

The park the job belongs to. Authorization and fairness scope.

TourRouteOptimizationJob.startDate ● Date! non-null scalar

The first day of the range.

TourRouteOptimizationJob.startedAt ● DateTime scalar

When the job was last claimed by a pod.

TourRouteOptimizationJob.status ● JobStatus! non-null enum

Lifecycle state.

TourRouteOptimizationJob.warnings ● [JobWarning!]! non-null object

Degradations the job worked around: TOUR_PLAN_TIMES_ESTIMATED once when the times of some days stayed estimated instead of routed.

Interfaces

Job interface

Asynchronous backend work. Poll job(id) until status is terminal.

Member Of

GenerateTourPlansPayload object