Google Maps FleetEngine V1 Client - Class GetVehicleRequest (0.1.2)

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

GetVehicle request message.

Generated from protobuf message maps.fleetengine.v1.GetVehicleRequest

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ header`	`Google\Maps\FleetEngine\V1\RequestHeader` The standard Fleet Engine request header.
`↳ name`	`string` Required. Must be in the format `providers/{provider}/vehicles/{vehicle}`. 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.
`↳ current_route_segment_version`	`Google\Protobuf\Timestamp` Indicates the minimum timestamp (exclusive) for which `Vehicle.current_route_segment` is retrieved. If the route is unchanged since this timestamp, the `current_route_segment` field is not set in the response. If a minimum is unspecified, the `current_route_segment` is always retrieved.
`↳ waypoints_version`	`Google\Protobuf\Timestamp` Indicates the minimum timestamp (exclusive) for which `Vehicle.waypoints` data is retrieved. If the waypoints are unchanged since this timestamp, the `vehicle.waypoints` data is not set in the response. If this field is unspecified, `vehicle.waypoints` is always retrieved.

getHeader

The standard Fleet Engine request header.

Returns
Type	Description
`Google\Maps\FleetEngine\V1\RequestHeader\|null`

hasHeader

clearHeader

setHeader

The standard Fleet Engine request header.

Parameter
Name	Description
`var`	`Google\Maps\FleetEngine\V1\RequestHeader`

Returns
Type	Description
`$this`

getName

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

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`

setName

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

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`

getCurrentRouteSegmentVersion

Indicates the minimum timestamp (exclusive) for which Vehicle.current_route_segment is retrieved.

If the route is unchanged since this timestamp, the current_route_segment field is not set in the response. If a minimum is unspecified, the current_route_segment is always retrieved.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCurrentRouteSegmentVersion

clearCurrentRouteSegmentVersion

setCurrentRouteSegmentVersion

Indicates the minimum timestamp (exclusive) for which Vehicle.current_route_segment is retrieved.

If the route is unchanged since this timestamp, the current_route_segment field is not set in the response. If a minimum is unspecified, the current_route_segment is always retrieved.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getWaypointsVersion

Indicates the minimum timestamp (exclusive) for which Vehicle.waypoints data is retrieved. If the waypoints are unchanged since this timestamp, the vehicle.waypoints data is not set in the response. If this field is unspecified, vehicle.waypoints is always retrieved.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasWaypointsVersion

clearWaypointsVersion

setWaypointsVersion

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`