Google Maps FleetEngine Delivery V1 Client - Class GetDeliveryVehicleRequest (0.1.4)

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

The GetDeliveryVehicle request message.

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

Namespace

Google \ Maps \ FleetEngine \ Delivery \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ header Google\Maps\FleetEngine\Delivery\V1\DeliveryRequestHeader

Optional. The standard Delivery API request header.
↳ name string

Required. Must be in the format providers/{provider}/deliveryVehicles/{delivery_vehicle}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

getHeader

Optional. The standard Delivery API request header.

Returns
Type Description
Google\Maps\FleetEngine\Delivery\V1\DeliveryRequestHeader|null

hasHeader

clearHeader

setHeader

Optional. The standard Delivery API request header.

Parameter
Name Description
var Google\Maps\FleetEngine\Delivery\V1\DeliveryRequestHeader
Returns
Type Description
$this

getName

Required. Must be in the format providers/{provider}/deliveryVehicles/{delivery_vehicle}.

The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Returns
Type Description
string

setName

Required. Must be in the format providers/{provider}/deliveryVehicles/{delivery_vehicle}.

The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Must be in the format providers/{provider}/deliveryVehicles/{delivery_vehicle}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project. Please see Google\Maps\FleetEngine\Delivery\V1\DeliveryServiceClient::deliveryVehicleName() for help formatting this field.
Returns
Type Description
Google\Maps\FleetEngine\Delivery\V1\GetDeliveryVehicleRequest