Console
    Contact Us Start free

    Google Maps FleetEngine V1 Client - Class UpdateTripRequest (0.1.6)

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

    UpdateTrip request message.

    Generated from protobuf message maps.fleetengine.v1.UpdateTripRequest

    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.

    ↳ name
    string

    Required. Must be in the format providers/{provider}/trips/{trip} . The provider must be the Project ID (for example, sample-consumer-project ) of the Google Cloud Project of which the service account making this call is a member.

    ↳ trip
    Trip

    Required. The Trip associated with the update. The following fields are maintained by the Fleet Engine. Do not update them using Trip.update. * * current_route_segment * * current_route_segment_end_point * * current_route_segment_traffic * * current_route_segment_traffic_version * * current_route_segment_version * * dropoff_time * * eta_to_next_waypoint * * intermediate_destinations_version * * last_location * * name * * number_of_passengers * * pickup_time * * remaining_distance_meters * * remaining_time_to_first_waypoint * * remaining_waypoints * * remaining_waypoints_version * * route When you update the Trip.vehicle_id for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints, otherwise the 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. To avoid a race condition for trips with multiple destinations, you should provide Trip.intermediate_destinations_version when updating the trip status to ENROUTE_TO_INTERMEDIATE_DESTINATION . The Trip.intermediate_destinations_version passed must be consistent with Fleet Engine's version. If it isn't, the request fails.

    ↳ update_mask
    Google\Protobuf\FieldMask

    Required. The field mask indicating which fields in Trip to update. The update_mask must contain at least one field.

    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

    getName

    Required. Must be in the format providers/{provider}/trips/{trip} . The provider must be the Project ID (for example, sample-consumer-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}/trips/{trip} . The provider must be the Project ID (for example, sample-consumer-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

    getTrip

    Required. The Trip associated with the update.

    The following fields are maintained by the Fleet Engine. Do not update them using Trip.update.

    • current_route_segment
    • current_route_segment_end_point
    • current_route_segment_traffic
    • current_route_segment_traffic_version
    • current_route_segment_version
    • dropoff_time
    • eta_to_next_waypoint
    • intermediate_destinations_version
    • last_location
    • name
    • number_of_passengers
    • pickup_time
    • remaining_distance_meters
    • remaining_time_to_first_waypoint
    • remaining_waypoints
    • remaining_waypoints_version
    • route When you update the Trip.vehicle_id for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints, otherwise the 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. To avoid a race condition for trips with multiple destinations, you should provide Trip.intermediate_destinations_version when updating the trip status to ENROUTE_TO_INTERMEDIATE_DESTINATION . The Trip.intermediate_destinations_version passed must be consistent with Fleet Engine's version. If it isn't, the request fails.
    Returns
    Type
    Description
    Trip |null

    hasTrip

    clearTrip

    setTrip

    Required. The Trip associated with the update.

    The following fields are maintained by the Fleet Engine. Do not update them using Trip.update.

    • current_route_segment
    • current_route_segment_end_point
    • current_route_segment_traffic
    • current_route_segment_traffic_version
    • current_route_segment_version
    • dropoff_time
    • eta_to_next_waypoint
    • intermediate_destinations_version
    • last_location
    • name
    • number_of_passengers
    • pickup_time
    • remaining_distance_meters
    • remaining_time_to_first_waypoint
    • remaining_waypoints
    • remaining_waypoints_version
    • route When you update the Trip.vehicle_id for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints, otherwise the 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. To avoid a race condition for trips with multiple destinations, you should provide Trip.intermediate_destinations_version when updating the trip status to ENROUTE_TO_INTERMEDIATE_DESTINATION . The Trip.intermediate_destinations_version passed must be consistent with Fleet Engine's version. If it isn't, the request fails.
    Parameter
    Name
    Description
    var
    Trip
    Returns
    Type
    Description
    $this

    getUpdateMask

    Required. The field mask indicating which fields in Trip to update.

    The update_mask must contain at least one field.

    Returns
    Type
    Description
    Google\Protobuf\FieldMask |null

    hasUpdateMask

    clearUpdateMask

    setUpdateMask

    Required. The field mask indicating which fields in Trip to update.

    The update_mask must contain at least one field.

    Parameter
    Name
    Description
    var
    Google\Protobuf\FieldMask
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: