REST Resource: providers.taskTrackingInfo

Resource: TaskTrackingInfo

The TaskTrackingInfo message. The message contains task tracking information which will be used for display. If a tracking ID is associated with multiple Tasks, Fleet Engine uses a heuristic to decide which Task's TaskTrackingInfo to select.

JSON representation 
{
  "name": string,
  "trackingId": string,
  "vehicleLocation": {
    object (DeliveryVehicleLocation)
  },
  "routePolylinePoints": [
    {
      object (LatLng)
    }
  ],
  "remainingStopCount": integer,
  "remainingDrivingDistanceMeters": integer,
  "estimatedArrivalTime": string,
  "estimatedTaskCompletionTime": string,
  "state": enum (State),
  "taskOutcome": enum (TaskOutcome),
  "taskOutcomeTime": string,
  "plannedLocation": {
    object (LocationInfo)
  },
  "targetTimeWindow": {
    object (TimeWindow)
  },
  "attributes": [
    {
      object (TaskAttribute)
    }
  ]
}
Fields
name

string

Must be in the format providers/{provider}/taskTrackingInfo/{tracking}, where tracking represents the tracking ID.
trackingId

string

Immutable. The tracking ID of a Task. * Must be a valid Unicode string. * Limited to a maximum length of 64 characters. * Normalized according to Unicode Normalization Form C. * May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.
vehicleLocation

object (DeliveryVehicleLocation)

The vehicle's last location.
routePolylinePoints[]

object (LatLng)

A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.
remainingStopCount

integer

Indicates the number of stops the vehicle remaining until the task stop is reached, including the task stop. For example, if the vehicle's next stop is the task stop, the value will be 1.
remainingDrivingDistanceMeters

integer

The total remaining distance in meters to the VehicleStop of interest.
estimatedArrivalTime

string (Timestamp format)

The timestamp that indicates the estimated arrival time to the stop location.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
estimatedTaskCompletionTime

string (Timestamp format)

The timestamp that indicates the estimated completion time of a Task.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
state

enum (State)

The current execution state of the Task.
taskOutcome

enum (TaskOutcome)

The outcome of attempting to execute a Task.
taskOutcomeTime

string (Timestamp format)

The timestamp that indicates when the Task's outcome was set by the provider.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
plannedLocation

object (LocationInfo)

Immutable. The location where the Task will be completed.
targetTimeWindow

object (TimeWindow)

The time window during which the task should be completed.
attributes[]

object (TaskAttribute)

The custom attributes set on the task.

Methods

get

 Returns the specified TaskTrackingInfo instance.