Google Maps FleetEngine V1 Client - Class CreateVehicleRequest (0.4.1)

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

CreateVehicle request message.

Generated from protobuf message maps.fleetengine.v1.CreateVehicleRequest

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ header`	`RequestHeader` The standard Fleet Engine request header.
`↳ parent`	`string` Required. Must be in the format `providers/{provider}`. The provider must be the Project ID (for example, `sample-cloud-project`) of the Google Cloud Project of which the service account making this call is a member.
`↳ vehicle_id`	`string` Required. Unique Vehicle ID. 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 '#'.
`↳ vehicle`	`Vehicle` Required. The Vehicle entity to create. When creating a Vehicle, the following fields are required: * * `vehicleState` * * `supportedTripTypes` * * `maximumCapacity` * * `vehicleType` When creating a Vehicle, the following fields are ignored: * * `name` * * `currentTrips` * * `availableCapacity` * * `current_route_segment` * * `current_route_segment_end_point` * * `current_route_segment_version` * * `current_route_segment_traffic` * * `route` * * `waypoints` * * `waypoints_version` * * `remaining_distance_meters` * * `remaining_time_seconds` * * `eta_to_next_waypoint` * * `navigation_status` All other fields are optional and used if provided.

getHeader

The standard Fleet Engine request header.

Returns
Type	Description
`RequestHeader\|null`

hasHeader

clearHeader

setHeader

The standard Fleet Engine request header.

Parameter
Name	Description
`var`	`RequestHeader`

Returns
Type	Description
`$this`

getParent

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

The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

Returns
Type	Description
`string`

setParent

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

The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVehicleId

Required. Unique Vehicle ID.

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`

setVehicleId