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.
data
array
Optional. Data for populating the Message object.
↳ name
string
Must be in the format providers/{provider}/taskTrackingInfo/{tracking}
, where tracking
represents the tracking ID.
↳ 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
↳ 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
↳ estimated_arrival_time
Google\Protobuf\Timestamp
The timestamp that indicates the estimated arrival time to the stop location.
↳ estimated_task_completion_time
↳ 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
↳ target_time_window
↳ attributes
getName
Must be in the format providers/{provider}/taskTrackingInfo/{tracking}
,
where tracking
represents the tracking ID.
string
setName
Must be in the format providers/{provider}/taskTrackingInfo/{tracking}
,
where tracking
represents the tracking ID.
var
string
$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 '#'.
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 '#'.
var
string
$this
getVehicleLocation
The vehicle's last location.
hasVehicleLocation
clearVehicleLocation
setVehicleLocation
The vehicle's last location.
$this
getRoutePolylinePoints
A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.
setRoutePolylinePoints
A list of points which when connected forms a polyline of the vehicle's expected route to the location of this task.
$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.
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.
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.
$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.
var
int|null
$this
getRemainingDrivingDistanceMeters
The total remaining distance in meters to the VehicleStop
of interest.
hasRemainingDrivingDistanceMeters
clearRemainingDrivingDistanceMeters
getRemainingDrivingDistanceMetersUnwrapped
Returns the unboxed value from getRemainingDrivingDistanceMeters()
The total remaining distance in meters to the VehicleStop
of interest.
int|null
setRemainingDrivingDistanceMeters
The total remaining distance in meters to the VehicleStop
of interest.
$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.
var
int|null
$this
getEstimatedArrivalTime
The timestamp that indicates the estimated arrival time to the stop location.
hasEstimatedArrivalTime
clearEstimatedArrivalTime
setEstimatedArrivalTime
The timestamp that indicates the estimated arrival time to the stop location.
$this
getEstimatedTaskCompletionTime
The timestamp that indicates the estimated completion time of a Task.
hasEstimatedTaskCompletionTime
clearEstimatedTaskCompletionTime
setEstimatedTaskCompletionTime
The timestamp that indicates the estimated completion time of a Task.
$this
getState
The current execution state of the Task.
int
setState
The current execution state of the Task.
var
int
$this
getTaskOutcome
The outcome of attempting to execute a Task.
int
setTaskOutcome
The outcome of attempting to execute a Task.
var
int
$this
getTaskOutcomeTime
The timestamp that indicates when the Task's outcome was set by the provider.
hasTaskOutcomeTime
clearTaskOutcomeTime
setTaskOutcomeTime
The timestamp that indicates when the Task's outcome was set by the provider.
$this
getPlannedLocation
Immutable. The location where the Task will be completed.
hasPlannedLocation
clearPlannedLocation
setPlannedLocation
Immutable. The location where the Task will be completed.
$this
getTargetTimeWindow
The time window during which the task should be completed.
hasTargetTimeWindow
clearTargetTimeWindow
setTargetTimeWindow
The time window during which the task should be completed.
$this
getAttributes
The custom attributes set on the task.
setAttributes
The custom attributes set on the task.
$this
