Class: Google::Maps::FleetEngine::V1::UpdateTripRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/maps/fleetengine/v1/trip_api.rb

Overview

UpdateTrip request message.

Instance Attribute Summary collapse

Instance Attribute Details

#header ⇒ ::Google::Maps::FleetEngine::V1::RequestHeader

Returns The standard Fleet Engine request header.

Returns:



236
237
238
239
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 236

class UpdateTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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:

  • (::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.



236
237
238
239
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 236

class UpdateTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trip ⇒ ::Google::Maps::FleetEngine::V1::Trip

Returns 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:

  • (::Google::Maps::FleetEngine::V1::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.



236
237
238
239
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 236

class UpdateTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

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

Returns:

  • (::Google::Protobuf::FieldMask) —

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



236
237
238
239
 
# File 'proto_docs/google/maps/fleetengine/v1/trip_api.rb', line 236

class UpdateTripRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end