Reference documentation and code samples for the Google Maps FleetEngine Delivery V1 Client class 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.
Generated from protobuf message maps.fleetengine.delivery.v1.TaskTrackingInfo
Namespace
Google \ Maps \ FleetEngine \ Delivery \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Must be in the format |
↳ tracking_id |
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 '#'. |
↳ vehicle_location |
DeliveryVehicleLocation
The vehicle's last location. |
↳ route_polyline_points |
array<Google\Type\LatLng>
A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task. |
↳ remaining_stop_count |
Google\Protobuf\Int32Value
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. |
↳ remaining_driving_distance_meters |
Google\Protobuf\Int32Value
The total remaining distance in meters to the |
↳ estimated_arrival_time |
Google\Protobuf\Timestamp
The timestamp that indicates the estimated arrival time to the stop location. |
↳ estimated_task_completion_time |
Google\Protobuf\Timestamp
The timestamp that indicates the estimated completion time of a Task. |
↳ state |
int
The current execution state of the Task. |
↳ task_outcome |
int
The outcome of attempting to execute a Task. |
↳ task_outcome_time |
Google\Protobuf\Timestamp
The timestamp that indicates when the Task's outcome was set by the provider. |
↳ planned_location |
LocationInfo
Immutable. The location where the Task will be completed. |
↳ target_time_window |
TimeWindow
The time window during which the task should be completed. |
↳ attributes |
array<TaskAttribute>
The custom attributes set on the task. |
getName
Must be in the format providers/{provider}/taskTrackingInfo/{tracking},
where tracking represents the tracking ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Must be in the format providers/{provider}/taskTrackingInfo/{tracking},
where tracking represents the tracking ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrackingId
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 '#'.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTrackingId
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 '#'.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVehicleLocation
The vehicle's last location.
| Returns | |
|---|---|
| Type | Description |
DeliveryVehicleLocation|null |
|
hasVehicleLocation
clearVehicleLocation
setVehicleLocation
The vehicle's last location.
| Parameter | |
|---|---|
| Name | Description |
var |
DeliveryVehicleLocation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRoutePolylinePoints
A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRoutePolylinePoints
A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Type\LatLng>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRemainingStopCount
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null |
|
hasRemainingStopCount
clearRemainingStopCount
getRemainingStopCountUnwrapped
Returns the unboxed value from getRemainingStopCount()
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.
| Returns | |
|---|---|
| Type | Description |
int|null |
|
setRemainingStopCount
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setRemainingStopCountUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRemainingDrivingDistanceMeters
The total remaining distance in meters to the VehicleStop of interest.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null |
|
hasRemainingDrivingDistanceMeters
clearRemainingDrivingDistanceMeters
getRemainingDrivingDistanceMetersUnwrapped
Returns the unboxed value from getRemainingDrivingDistanceMeters()
The total remaining distance in meters to the VehicleStop of interest.
| Returns | |
|---|---|
| Type | Description |
int|null |
|
setRemainingDrivingDistanceMeters
The total remaining distance in meters to the VehicleStop of interest.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setRemainingDrivingDistanceMetersUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
The total remaining distance in meters to the VehicleStop of interest.
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEstimatedArrivalTime
The timestamp that indicates the estimated arrival time to the stop location.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEstimatedArrivalTime
clearEstimatedArrivalTime
setEstimatedArrivalTime
The timestamp that indicates the estimated arrival time to the stop location.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEstimatedTaskCompletionTime
The timestamp that indicates the estimated completion time of a Task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEstimatedTaskCompletionTime
clearEstimatedTaskCompletionTime
setEstimatedTaskCompletionTime
The timestamp that indicates the estimated completion time of a Task.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
The current execution state of the Task.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
The current execution state of the Task.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskOutcome
The outcome of attempting to execute a Task.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTaskOutcome
The outcome of attempting to execute a Task.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskOutcomeTime
The timestamp that indicates when the Task's outcome was set by the provider.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasTaskOutcomeTime
clearTaskOutcomeTime
setTaskOutcomeTime
The timestamp that indicates when the Task's outcome was set by the provider.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlannedLocation
Immutable. The location where the Task will be completed.
| Returns | |
|---|---|
| Type | Description |
LocationInfo|null |
|
hasPlannedLocation
clearPlannedLocation
setPlannedLocation
Immutable. The location where the Task will be completed.
| Parameter | |
|---|---|
| Name | Description |
var |
LocationInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetTimeWindow
The time window during which the task should be completed.
| Returns | |
|---|---|
| Type | Description |
TimeWindow|null |
|
hasTargetTimeWindow
clearTargetTimeWindow
setTargetTimeWindow
The time window during which the task should be completed.
| Parameter | |
|---|---|
| Name | Description |
var |
TimeWindow
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAttributes
The custom attributes set on the task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAttributes
The custom attributes set on the task.
| Parameter | |
|---|---|
| Name | Description |
var |
array<TaskAttribute>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|