Google Maps FleetEngine Delivery V1 Client - Class VehicleStop (0.5.1)

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

Describes a point where a Vehicle stops to perform one or more Tasks.

Generated from protobuf message maps.fleetengine.delivery.v1.VehicleStop

Namespace

Google \ Maps \ FleetEngine \ Delivery \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ planned_location LocationInfo

Required. The location of the stop. Note that the locations in the Tasks might not exactly match this location, but will be within a short distance of it. This field won't be populated in the response of a GetTask call.
↳ tasks array<VehicleStop\TaskInfo>

The list of Tasks to be performed at this stop. This field won't be populated in the response of a GetTask call.
↳ state int

The state of the VehicleStop. This field won't be populated in the response of a GetTask call.

getPlannedLocation

Required. The location of the stop. Note that the locations in the Tasks might not exactly match this location, but will be within a short distance of it. This field won't be populated in the response of a GetTask call.

Returns
Type Description
LocationInfo|null

hasPlannedLocation

clearPlannedLocation

setPlannedLocation

Required. The location of the stop. Note that the locations in the Tasks might not exactly match this location, but will be within a short distance of it. This field won't be populated in the response of a GetTask call.

Parameter
Name Description
var LocationInfo
Returns
Type Description
$this

getTasks

The list of Tasks to be performed at this stop. This field won't be populated in the response of a GetTask call.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTasks

The list of Tasks to be performed at this stop. This field won't be populated in the response of a GetTask call.

Parameter
Name Description
var array<VehicleStop\TaskInfo>
Returns
Type Description
$this

getState

The state of the VehicleStop. This field won't be populated in the response of a GetTask call.

Returns
Type Description
int

setState

The state of the VehicleStop. This field won't be populated in the response of a GetTask call.

Parameter
Name Description
var int
Returns
Type Description
$this