Google Maps FleetEngine V1 Client - Class TripWaypoint (0.1.2)

Reference documentation and code samples for the Google Maps FleetEngine V1 Client class TripWaypoint.

Describes a stopping point on a vehicle's route or an ending point on a vehicle's trip.

Generated from protobuf message maps.fleetengine.v1.TripWaypoint

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ location`	`Google\Maps\FleetEngine\V1\TerminalLocation` The location of this waypoint.
`↳ trip_id`	`string` The trip associated with this waypoint.
`↳ waypoint_type`	`int` The role this waypoint plays in this trip, such as pickup or dropoff.
`↳ path_to_waypoint`	`array<Google\Type\LatLng>` The path from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list. This field is only populated when requested.
`↳ encoded_path_to_waypoint`	`string` The encoded path from the previous waypoint to the current waypoint. Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.
`↳ traffic_to_waypoint`	`Google\Maps\FleetEngine\V1\ConsumableTrafficPolyline` The traffic conditions along the path to this waypoint. Note that traffic is only available for Google Map Platform Rides and Deliveries Solution customers.
`↳ distance_meters`	`Google\Protobuf\Int32Value` The path distance from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list.
`↳ eta`	`Google\Protobuf\Timestamp` The estimated time of arrival at this waypoint. Undefined for the first waypoint in a list.
`↳ duration`	`Google\Protobuf\Duration` The travel time from previous waypoint to this point. Undefined for the first waypoint in a list.

getLocation

The location of this waypoint.

Returns
Type	Description
`Google\Maps\FleetEngine\V1\TerminalLocation\|null`

hasLocation

clearLocation

setLocation

The location of this waypoint.

Parameter
Name	Description
`var`	`Google\Maps\FleetEngine\V1\TerminalLocation`

Returns
Type	Description
`$this`

getTripId

The trip associated with this waypoint.

Returns
Type	Description
`string`

setTripId

The trip associated with this waypoint.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getWaypointType

The role this waypoint plays in this trip, such as pickup or dropoff.

Returns
Type	Description
`int`

setWaypointType

The role this waypoint plays in this trip, such as pickup or dropoff.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPathToWaypoint

The path from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list. This field is only populated when requested.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPathToWaypoint

The path from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list. This field is only populated when requested.

Parameter
Name	Description
`var`	`array<Google\Type\LatLng>`

Returns
Type	Description
`$this`

getEncodedPathToWaypoint

The encoded path from the previous waypoint to the current waypoint.

Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.

Returns
Type	Description
`string`

setEncodedPathToWaypoint

The encoded path from the previous waypoint to the current waypoint.

Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTrafficToWaypoint

The traffic conditions along the path to this waypoint. Note that traffic is only available for Google Map Platform Rides and Deliveries Solution customers.

Returns
Type	Description
`Google\Maps\FleetEngine\V1\ConsumableTrafficPolyline\|null`

hasTrafficToWaypoint

clearTrafficToWaypoint

setTrafficToWaypoint

The traffic conditions along the path to this waypoint. Note that traffic is only available for Google Map Platform Rides and Deliveries Solution customers.

Parameter
Name	Description
`var`	`Google\Maps\FleetEngine\V1\ConsumableTrafficPolyline`

Returns
Type	Description
`$this`

getDistanceMeters

The path distance from the previous waypoint to the current waypoint.

Undefined for the first waypoint in a list.

Returns
Type	Description
`Google\Protobuf\Int32Value\|null`

hasDistanceMeters

clearDistanceMeters

getDistanceMetersUnwrapped

Returns the unboxed value from getDistanceMeters()

The path distance from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list.

Returns
Type	Description
`int\|null`

setDistanceMeters

The path distance from the previous waypoint to the current waypoint.

Undefined for the first waypoint in a list.

Parameter
Name	Description
`var`	`Google\Protobuf\Int32Value`

Returns
Type	Description
`$this`

setDistanceMetersUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

The path distance from the previous waypoint to the current waypoint. Undefined for the first waypoint in a list.

Parameter
Name	Description
`var`	`int\|null`

Returns
Type	Description
`$this`

getEta

The estimated time of arrival at this waypoint. Undefined for the first waypoint in a list.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEta

clearEta

setEta

The estimated time of arrival at this waypoint. Undefined for the first waypoint in a list.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDuration

The travel time from previous waypoint to this point. Undefined for the first waypoint in a list.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasDuration

clearDuration

setDuration

The travel time from previous waypoint to this point. Undefined for the first waypoint in a list.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`