Google Maps FleetEngine Delivery V1 Client - Class UpdateDeliveryVehicleRequest (0.1.6)

Version latest

• 0.1.6 (latest)
• 0.1.5

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

The UpdateDeliveryVehicle request message.

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

Namespace

Google \ Maps \ FleetEngine \ Delivery \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ header	DeliveryRequestHeader Optional. The standard Delivery API request header.
↳ delivery_vehicle	DeliveryVehicle Required. The DeliveryVehicle entity update to apply. Note: You cannot update the name of the DeliveryVehicle.
↳ update_mask	Google\Protobuf\FieldMask Required. A field mask that indicates which DeliveryVehicle fields to update. Note that the update_mask must contain at least one field. This is a comma-separated list of fully qualified names of fields. Example: "remaining_vehicle_journey_segments".

getHeader

Optional. The standard Delivery API request header.

Returns
Type	Description
DeliveryRequestHeader|null

hasHeader

clearHeader

setHeader

Optional. The standard Delivery API request header.

Parameter
Name	Description
var	DeliveryRequestHeader

Returns
Type	Description
$this

getDeliveryVehicle

Required. The DeliveryVehicle entity update to apply.

Note: You cannot update the name of the DeliveryVehicle.

Returns
Type	Description
DeliveryVehicle|null

hasDeliveryVehicle

clearDeliveryVehicle

setDeliveryVehicle

Required. The DeliveryVehicle entity update to apply.

Note: You cannot update the name of the DeliveryVehicle.

Parameter
Name	Description
var	DeliveryVehicle

Returns
Type	Description
$this

getUpdateMask

Required. A field mask that indicates which DeliveryVehicle fields to update. Note that the update_mask must contain at least one field.

This is a comma-separated list of fully qualified names of fields. Example: "remaining_vehicle_journey_segments".

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. A field mask that indicates which DeliveryVehicle fields to update. Note that the update_mask must contain at least one field.

This is a comma-separated list of fully qualified names of fields. Example: "remaining_vehicle_journey_segments".

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

static::build

Parameters
Name	Description
deliveryVehicle	DeliveryVehicle Required. The DeliveryVehicle entity update to apply. Note: You cannot update the name of the DeliveryVehicle.
updateMask	Google\Protobuf\FieldMask Required. A field mask that indicates which DeliveryVehicle fields to update. Note that the update_mask must contain at least one field. This is a comma-separated list of fully qualified names of fields. Example: "remaining_vehicle_journey_segments".

Returns
Type	Description
UpdateDeliveryVehicleRequest