Google Maps FleetEngine V1 Client - Class CreateTripRequest (0.5.1)

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

CreateTrip request message.

Generated from protobuf message maps.fleetengine.v1.CreateTripRequest

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

Required. Unique Trip 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 '#'.
↳ trip Trip

Required. Trip entity to create. When creating a Trip, the following fields are required: * * trip_type * * pickup_point The following fields are used if you provide them: * * number_of_passengers * * vehicle_id * * dropoff_point * * intermediate_destinations * * vehicle_waypoints All other Trip fields are ignored. For example, all trips start with a trip_status of NEW even if you pass in a trip_status of CANCELED in the creation request. Only EXCLUSIVE trips support intermediate_destinations. When vehicle_id is set for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints for the vehicle, otherwise the waypoint order will be undetermined. When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips. The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.

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

getTripId

Required. Unique Trip 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

setTripId

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

getTrip

Required. Trip entity to create.

When creating a Trip, the following fields are required:

  • trip_type
  • pickup_point The following fields are used if you provide them:
  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints All other Trip fields are ignored. For example, all trips start with a trip_status of NEW even if you pass in a trip_status of CANCELED in the creation request. Only EXCLUSIVE trips support intermediate_destinations. When vehicle_id is set for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints for the vehicle, otherwise the waypoint order will be undetermined. When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips. The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.
Returns
Type Description
Trip|null

hasTrip

clearTrip

setTrip

Required. Trip entity to create.

When creating a Trip, the following fields are required:

  • trip_type
  • pickup_point The following fields are used if you provide them:
  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints All other Trip fields are ignored. For example, all trips start with a trip_status of NEW even if you pass in a trip_status of CANCELED in the creation request. Only EXCLUSIVE trips support intermediate_destinations. When vehicle_id is set for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints for the vehicle, otherwise the waypoint order will be undetermined. When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips. The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.
Parameter
Name Description
var Trip
Returns
Type Description
$this