Class: Google::Maps::FleetEngine::V1::Trip

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

Overview

Trip metadata.

Instance Attribute Summary collapse

Instance Attribute Details

#actual_dropoff_point ⇒ ::Google::Maps::FleetEngine::V1::StopLocation

Returns Input only. The actual time and location when and where customer was dropped off. This field is for provider to provide feedback on actual dropoff information.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#actual_intermediate_destination_arrival_points ⇒ ::Array<::Google::Maps::FleetEngine::V1::StopLocation>

Returns Input only. The actual time and location of the driver's arrival at an intermediate destination. This field is for provider to provide feedback on actual arrival information at intermediate destinations.

Returns:

  • (::Array<::Google::Maps::FleetEngine::V1::StopLocation>) —

    Input only. The actual time and location of the driver's arrival at an intermediate destination. This field is for provider to provide feedback on actual arrival information at intermediate destinations.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#actual_intermediate_destinations ⇒ ::Array<::Google::Maps::FleetEngine::V1::StopLocation>

Returns Input only. The actual time and location when and where the customer was picked up from an intermediate destination. This field is for provider to provide feedback on actual pickup information at intermediate destinations.

Returns:

  • (::Array<::Google::Maps::FleetEngine::V1::StopLocation>) —

    Input only. The actual time and location when and where the customer was picked up from an intermediate destination. This field is for provider to provide feedback on actual pickup information at intermediate destinations.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#actual_pickup_arrival_point ⇒ ::Google::Maps::FleetEngine::V1::StopLocation

Returns Input only. The actual time and location of the driver arrival at the pickup point. This field is for provider to provide feedback on actual arrival information at the pickup point.

Returns:

  • (::Google::Maps::FleetEngine::V1::StopLocation) —

    Input only. The actual time and location of the driver arrival at the pickup point. This field is for provider to provide feedback on actual arrival information at the pickup point.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#actual_pickup_point ⇒ ::Google::Maps::FleetEngine::V1::StopLocation

Returns Input only. The actual location when and where customer was picked up. This field is for provider to provide feedback on actual pickup information.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#attributes ⇒ ::Array<::Google::Maps::FleetEngine::V1::TripAttribute>

Returns A list of custom Trip attributes. Each attribute must have a unique key.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#current_route_segment ⇒ ::String (readonly)

Returns Output only. An encoded path to the next waypoint.

Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.

Returns:

  • (::String) —

    Output only. An encoded path to the next waypoint.

    Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#current_route_segment_end_point ⇒ ::Google::Maps::FleetEngine::V1::TripWaypoint (readonly)

Returns Output only. The waypoint where current_route_segment ends.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#current_route_segment_traffic ⇒ ::Google::Maps::FleetEngine::V1::ConsumableTrafficPolyline (readonly)

Returns Output only. Indicates the traffic conditions along the current_route_segment when they're available.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#current_route_segment_traffic_version ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Indicates the last time the current_route_segment_traffic was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Indicates the last time the current_route_segment_traffic was modified.

    Note: This field is intended only for use by the Driver SDK and Consumer SDK.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#current_route_segment_version ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Indicates the last time the route was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Indicates the last time the route was modified.

    Note: This field is intended only for use by the Driver SDK and Consumer SDK.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#dropoff_point ⇒ ::Google::Maps::FleetEngine::V1::TerminalLocation

Returns Location where customer indicates they will be dropped off.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#dropoff_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Either the estimated future time when the rider(s) will be dropped off at the final destination, or the actual time when they were dropped off.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Either the estimated future time when the rider(s) will be dropped off at the final destination, or the actual time when they were dropped off.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#eta_to_first_waypoint ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The ETA to the next waypoint (the first entry in the remaining_waypoints field). The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The ETA to the next waypoint (the first entry in the remaining_waypoints field). The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#intermediate_destination_index ⇒ ::Integer

Returns When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle is at. The provider sets this value. If there are no intermediate_destinations, this field is ignored.

Returns:

  • (::Integer) —

    When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle is at. The provider sets this value. If there are no intermediate_destinations, this field is ignored.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#intermediate_destinations ⇒ ::Array<::Google::Maps::FleetEngine::V1::TerminalLocation>

Returns Intermediate stops in order that the trip requests (in addition to pickup and dropoff). Initially this will not be supported for shared trips.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#intermediate_destinations_version ⇒ ::Google::Protobuf::Timestamp

Returns Indicates the last time the intermediate_destinations was modified. Your server should cache this value and pass it in UpdateTripRequest when update intermediate_destination_index to ensure the intermediate_destinations is not changed.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Indicates the last time the intermediate_destinations was modified. Your server should cache this value and pass it in UpdateTripRequest when update intermediate_destination_index to ensure the intermediate_destinations is not changed.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#last_location ⇒ ::Google::Maps::FleetEngine::V1::VehicleLocation (readonly)

Returns Output only. Indicates the last reported location of the vehicle along the route.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#last_location_snappable ⇒ ::Boolean (readonly)

Returns Output only. Indicates whether the vehicle's last_location can be snapped to the current_route_segment. False if last_location or current_route_segment doesn't exist. It is computed by Fleet Engine. Any update from clients will be ignored.

Returns:

  • (::Boolean) —

    Output only. Indicates whether the vehicle's last_location can be snapped to the current_route_segment. False if last_location or current_route_segment doesn't exist. It is computed by Fleet Engine. Any update from clients will be ignored.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#name ⇒ ::String (readonly)

Returns Output only. In the format "providers/{provider}/trips/{trip}".

Returns:

  • (::String) —

    Output only. In the format "providers/{provider}/trips/{trip}"



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#number_of_passengers ⇒ ::Integer

Returns Immutable. Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in a SearchVehicles response.

Returns:

  • (::Integer) —

    Immutable. Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in a SearchVehicles response.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#pickup_point ⇒ ::Google::Maps::FleetEngine::V1::TerminalLocation

Returns Location where customer indicates they will be picked up.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#pickup_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#remaining_distance_meters ⇒ ::Google::Protobuf::Int32Value (readonly)

Returns Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.

Returns:

  • (::Google::Protobuf::Int32Value) —

    Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#remaining_time_to_first_waypoint ⇒ ::Google::Protobuf::Duration (readonly)

Returns Output only. The duration from when the Trip data is returned to the time in Trip.eta_to_first_waypoint. The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Returns:

  • (::Google::Protobuf::Duration) —

    Output only. The duration from when the Trip data is returned to the time in Trip.eta_to_first_waypoint. The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#remaining_waypoints ⇒ ::Array<::Google::Maps::FleetEngine::V1::TripWaypoint> (readonly)

Returns Output only. The full path from the current location to the dropoff point, inclusive. This path could include waypoints from other trips.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#remaining_waypoints_route_version ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Indicates the last time the remaining_waypoints.path_to_waypoint and remaining_waypoints.traffic_to_waypoint were modified. Your client app should cache this value and pass it in GetTripRequest to ensure the paths and traffic for remaining_waypoints are only returned if updated.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Indicates the last time the remaining_waypoints.path_to_waypoint and remaining_waypoints.traffic_to_waypoint were modified. Your client app should cache this value and pass it in GetTripRequest to ensure the paths and traffic for remaining_waypoints are only returned if updated.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#remaining_waypoints_version ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Indicates the last time that remaining_waypoints was changed (a waypoint was added, removed, or changed).

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Indicates the last time that remaining_waypoints was changed (a waypoint was added, removed, or changed).



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#route ⇒ ::Array<::Google::Type::LatLng> (readonly)

Returns Output only. Anticipated route for this trip to the first entry in remaining_waypoints. Note that the first waypoint may belong to a different trip.

Returns:

  • (::Array<::Google::Type::LatLng>) —

    Output only. Anticipated route for this trip to the first entry in remaining_waypoints. Note that the first waypoint may belong to a different trip.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#trip_status ⇒ ::Google::Maps::FleetEngine::V1::TripStatus

Returns Current status of the trip.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#trip_type ⇒ ::Google::Maps::FleetEngine::V1::TripType

Returns The type of the trip.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#vehicle_id ⇒ ::String

Returns ID of the vehicle making this trip.

Returns:

  • (::String) —

    ID of the vehicle making this trip.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#vehicle_waypoints ⇒ ::Array<::Google::Maps::FleetEngine::V1::TripWaypoint>

Returns This field supports manual ordering of the waypoints for the trip. It contains all of the remaining waypoints for the assigned vehicle, as well as the pickup and drop-off waypoints for this trip. If the trip hasn't been assigned to a vehicle, then Fleet Engine ignores this field. For privacy reasons, this field is only populated by the server on UpdateTrip and CreateTrip calls, NOT on GetTrip calls.

Returns:

  • (::Array<::Google::Maps::FleetEngine::V1::TripWaypoint>) —

    This field supports manual ordering of the waypoints for the trip. It contains all of the remaining waypoints for the assigned vehicle, as well as the pickup and drop-off waypoints for this trip. If the trip hasn't been assigned to a vehicle, then Fleet Engine ignores this field. For privacy reasons, this field is only populated by the server on UpdateTrip and CreateTrip calls, NOT on GetTrip calls.



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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

#view ⇒ ::Google::Maps::FleetEngine::V1::TripView

Returns The subset of Trip fields that are populated and how they should be interpreted.

Returns:



193
194
195
196
 
# File 'proto_docs/google/maps/fleetengine/v1/trips.rb', line 193

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