Class: Google::Maps::FleetEngine::V1::VehicleMatch

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

Overview

Contains the vehicle and related estimates for a vehicle that match the points of active trips for the vehicle SearchVehiclesRequest.

Defined Under Namespace

Modules: VehicleMatchType

Instance Attribute Summary collapse

Instance Attribute Details

#ordered_by ⇒ ::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder

Returns The actual order that was used for this vehicle. Normally this will match the 'order_by' field from the request; however, in certain circumstances such as an internal server error, a different method may be used (such as PICKUP_POINT_STRAIGHT_DISTANCE).

Returns:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#requested_ordered_by ⇒ ::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder

Returns The order requested for sorting vehicle matches.

Returns:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

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

Returns Required. The trip type of the request that was used to calculate the ETA to the pickup point.

Returns:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle ⇒ ::Google::Maps::FleetEngine::V1::Vehicle

Returns Required. A vehicle that matches the request.

Returns:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_dropoff_eta ⇒ ::Google::Protobuf::Timestamp

Returns The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes stopping at any waypoints before the dropoff_point specified in the request. The value will only be populated when a drop off point is specified in the request. An empty value indicates an error calculating the ETA.

Returns:

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

    The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes stopping at any waypoints before the dropoff_point specified in the request. The value will only be populated when a drop off point is specified in the request. An empty value indicates an error calculating the ETA.



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_match_type ⇒ ::Google::Maps::FleetEngine::V1::VehicleMatch::VehicleMatchType

Returns Type of the vehicle match.

Returns:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_pickup_distance_meters ⇒ ::Google::Protobuf::Int32Value

Returns The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.

Returns:

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

    The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_pickup_eta ⇒ ::Google::Protobuf::Timestamp

Returns The vehicle's driving ETA to the pickup point specified in the request. An empty value indicates a failure in calculating ETA for the vehicle. If SearchVehiclesRequest.include_back_to_back was true and this vehicle has an active trip, vehicle_pickup_eta includes the time required to complete the current active trip.

Returns:

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

    The vehicle's driving ETA to the pickup point specified in the request. An empty value indicates a failure in calculating ETA for the vehicle. If SearchVehiclesRequest.include_back_to_back was true and this vehicle has an active trip, vehicle_pickup_eta includes the time required to complete the current active trip.



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_pickup_straight_line_distance_meters ⇒ ::Google::Protobuf::Int32Value

Returns Required. The straight-line distance between the vehicle and the pickup point specified in the request.

Returns:



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_pickup_to_dropoff_distance_meters ⇒ ::Google::Protobuf::Int32Value

Returns The vehicle's driving distance (in meters) from the pickup point to the drop off point specified in the request. The distance is only between the two points and does not include the vehicle location or any other points that must be visited before the vehicle visits either the pickup point or dropoff point. The value will only be populated when a dropoff_point is specified in the request. An empty value indicates a failure in calculating the distance from the pickup to drop off point specified in the request.

Returns:

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

    The vehicle's driving distance (in meters) from the pickup point to the drop off point specified in the request. The distance is only between the two points and does not include the vehicle location or any other points that must be visited before the vehicle visits either the pickup point or dropoff point. The value will only be populated when a dropoff_point is specified in the request. An empty value indicates a failure in calculating the distance from the pickup to drop off point specified in the request.



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end

#vehicle_trips_waypoints ⇒ ::Array<::Google::Maps::FleetEngine::V1::Waypoint>

Returns The ordered list of waypoints used to calculate the ETA. The list includes vehicle location, the pickup points of active trips for the vehicle, and the pickup points provided in the request. An empty list indicates a failure in calculating ETA for the vehicle.

Returns:

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

    The ordered list of waypoints used to calculate the ETA. The list includes vehicle location, the pickup points of active trips for the vehicle, and the pickup points provided in the request. An empty list indicates a failure in calculating ETA for the vehicle.



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 620

class VehicleMatch
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of vehicle match.
  module VehicleMatchType
    # Unknown vehicle match type
    UNKNOWN = 0

    # The vehicle currently has no trip assigned to it and can proceed to the
    # pickup point.
    EXCLUSIVE = 1

    # The vehicle is currently assigned to a trip, but can proceed to the
    # pickup point after completing the in-progress trip.  ETA and distance
    # calculations take the existing trip into account.
    BACK_TO_BACK = 2

    # The vehicle has sufficient capacity for a shared ride.
    CARPOOL = 3

    # The vehicle will finish its current, active trip before proceeding to the
    # pickup point.  ETA and distance calculations take the existing trip into
    # account.
    CARPOOL_BACK_TO_BACK = 4
  end
end