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

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

The CreateDeliveryVehicle request message.

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

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.
↳ parent string

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

Required. The Delivery Vehicle ID must be unique and subject to the following restrictions: * 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 '#'.
↳ delivery_vehicle Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle

Required. The DeliveryVehicle entity to create. When creating a new delivery vehicle, you may set the following optional fields: * type * last_location * attributes Note: The DeliveryVehicle's name field is ignored. All other DeliveryVehicle fields must not be set; otherwise, an error is returned.

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

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDeliveryVehicleId

Required. The Delivery Vehicle ID must be unique and subject to the following restrictions:

  • 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 '#'.
Returns
Type Description
string

setDeliveryVehicleId

Required. The Delivery Vehicle ID must be unique and subject to the following restrictions:

  • 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 '#'.
Parameter
Name Description
var string
Returns
Type Description
$this

getDeliveryVehicle

Required. The DeliveryVehicle entity to create. When creating a new delivery vehicle, you may set the following optional fields:

  • type
  • last_location
  • attributes Note: The DeliveryVehicle's name field is ignored. All other DeliveryVehicle fields must not be set; otherwise, an error is returned.
Returns
Type Description
Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle|null

hasDeliveryVehicle

clearDeliveryVehicle

setDeliveryVehicle

Required. The DeliveryVehicle entity to create. When creating a new delivery vehicle, you may set the following optional fields:

  • type
  • last_location
  • attributes Note: The DeliveryVehicle's name field is ignored. All other DeliveryVehicle fields must not be set; otherwise, an error is returned.
Parameter
Name Description
var Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.
deliveryVehicle Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle

Required. The DeliveryVehicle entity to create. When creating a new delivery vehicle, you may set the following optional fields:

  • type
  • last_location
  • attributes

Note: The DeliveryVehicle's name field is ignored. All other DeliveryVehicle fields must not be set; otherwise, an error is returned.
deliveryVehicleId string

Required. The Delivery Vehicle ID must be unique and subject to the following restrictions:

  • 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 '#'.
Returns
Type Description
Google\Maps\FleetEngine\Delivery\V1\CreateDeliveryVehicleRequest