Class: Google::Maps::FleetEngine::V1::SearchVehiclesRequest

Inherits:

Object

Object
Google::Maps::FleetEngine::V1::SearchVehiclesRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/maps/fleetengine/v1/vehicle_api.rb

Overview

SearchVehicles request message.

Defined Under Namespace

Modules: CurrentTripsPresent, VehicleMatchOrder

Instance Attribute Summary collapse

#count ⇒ ::Integer
Required.
#current_trips_present ⇒ ::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::CurrentTripsPresent
This indicates if vehicles with active trips are eligible for this search.
#dropoff_point ⇒ ::Google::Maps::FleetEngine::V1::TerminalLocation
The customer's intended dropoff location.
#filter ⇒ ::String
Optional.
#header ⇒ ::Google::Maps::FleetEngine::V1::RequestHeader
The standard Fleet Engine request header.
#include_back_to_back ⇒ ::Boolean
This indicates if vehicles with a single active trip are eligible for this search.
#maximum_staleness ⇒ ::Google::Protobuf::Duration
Restricts the search to only those vehicles that have sent location updates to Fleet Engine within the specified duration.
#minimum_capacity ⇒ ::Integer
Required.
#order_by ⇒ ::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder
Required.
#parent ⇒ ::String
Required.
#pickup_point ⇒ ::Google::Maps::FleetEngine::V1::TerminalLocation
Required.
#pickup_radius_meters ⇒ ::Integer
Required.
#required_attributes ⇒ ::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>
Callers can form complex logical operations using any combination of the required_attributes, required_one_of_attributes, and required_one_of_attribute_sets fields.
#required_one_of_attribute_sets ⇒ ::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>
required_one_of_attribute_sets provides additional functionality.
#required_one_of_attributes ⇒ ::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>
Restricts the search to only those vehicles with at least one of the specified attributes in each VehicleAttributeList.
#trip_id ⇒ ::String
Indicates the trip associated with this SearchVehicleRequest.
#trip_types ⇒ ::Array<::Google::Maps::FleetEngine::V1::TripType>
Required.
#vehicle_types ⇒ ::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType>
Required.

Instance Attribute Details

#count ⇒ `::Integer`

Returns Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive).

Returns:

(::Integer) —
Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive).

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#current_trips_present ⇒ `::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::CurrentTripsPresent`

Returns This indicates if vehicles with active trips are eligible for this search. This must be set to something other than CURRENT_TRIPS_PRESENT_UNSPECIFIED if trip_type includes SHARED.

Returns:

(::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::CurrentTripsPresent) —
This indicates if vehicles with active trips are eligible for this search. This must be set to something other than CURRENT_TRIPS_PRESENT_UNSPECIFIED if trip_type includes SHARED.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

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

Returns The customer's intended dropoff location. The field is required if trip_types contains TripType.SHARED.

Returns:

(::Google::Maps::FleetEngine::V1::TerminalLocation) —
The customer's intended dropoff location. The field is required if trip_types contains TripType.SHARED.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#filter ⇒ `::String`

Returns Optional. A filter query to apply when searching vehicles. See http://aip.dev/160 for examples of the filter syntax.

This field is designed to replace the required_attributes, required_one_of_attributes, and required_one_of_attributes_sets fields. If a non-empty value is specified here, the following fields must be empty: required_attributes, required_one_of_attributes, and required_one_of_attributes_sets.

This filter functions as an AND clause with other constraints, such as minimum_capacity or vehicle_types.

Note that the only queries supported are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed in a filter query is 50.

Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").

Returns:

(::String) —
Optional. A filter query to apply when searching vehicles. See http://aip.dev/160 for examples of the filter syntax.

This field is designed to replace the required_attributes, required_one_of_attributes, and required_one_of_attributes_sets fields. If a non-empty value is specified here, the following fields must be empty: required_attributes, required_one_of_attributes, and required_one_of_attributes_sets.

This filter functions as an AND clause with other constraints, such as minimum_capacity or vehicle_types.

Note that the only queries supported are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed in a filter query is 50.

Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

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

Returns The standard Fleet Engine request header.

Returns:

(::Google::Maps::FleetEngine::V1::RequestHeader) —
The standard Fleet Engine request header.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#include_back_to_back ⇒ `::Boolean`

Returns This indicates if vehicles with a single active trip are eligible for this search. This field is only used when current_trips_present is unspecified. When current_trips_present is unspecified and this field is false, vehicles with assigned trips are excluded from the search results. When current_trips_present is unspecified and this field is true, search results can include vehicles with one active trip that has a status of ENROUTE_TO_DROPOFF. When current_trips_present is specified, this field cannot be set to true.

The default value is false.

Returns:

(::Boolean) —
This indicates if vehicles with a single active trip are eligible for this search. This field is only used when current_trips_present is unspecified. When current_trips_present is unspecified and this field is false, vehicles with assigned trips are excluded from the search results. When current_trips_present is unspecified and this field is true, search results can include vehicles with one active trip that has a status of ENROUTE_TO_DROPOFF. When current_trips_present is specified, this field cannot be set to true.

The default value is false.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#maximum_staleness ⇒ `::Google::Protobuf::Duration`

Returns Restricts the search to only those vehicles that have sent location updates to Fleet Engine within the specified duration. Stationary vehicles still transmitting their locations are not considered stale. If this field is not set, the server uses five minutes as the default value.

Returns:

(::Google::Protobuf::Duration) —
Restricts the search to only those vehicles that have sent location updates to Fleet Engine within the specified duration. Stationary vehicles still transmitting their locations are not considered stale. If this field is not set, the server uses five minutes as the default value.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#minimum_capacity ⇒ `::Integer`

Returns Required. Specifies the number of passengers being considered for a trip. The value must be greater than or equal to one. The driver is not considered in the capacity value.

Returns:

(::Integer) —
Required. Specifies the number of passengers being considered for a trip. The value must be greater than or equal to one. The driver is not considered in the capacity value.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#order_by ⇒ `::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder`

Returns Required. Specifies the desired ordering criterion for results.

Returns:

(::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder) —
Required. Specifies the desired ordering criterion for results.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#parent ⇒ `::String`

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

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

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

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

Returns Required. The pickup point to search near.

Returns:

(::Google::Maps::FleetEngine::V1::TerminalLocation) —
Required. The pickup point to search near.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#pickup_radius_meters ⇒ `::Integer`

Returns Required. Defines the vehicle search radius around the pickup point. Only vehicles within the search radius will be returned. Value must be between 400 and 10000 meters (inclusive).

Returns:

(::Integer) —
Required. Defines the vehicle search radius around the pickup point. Only vehicles within the search radius will be returned. Value must be between 400 and 10000 meters (inclusive).

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#required_attributes ⇒ `::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>`

Returns Callers can form complex logical operations using any combination of the required_attributes, required_one_of_attributes, and required_one_of_attribute_sets fields.

required_attributes is a list; required_one_of_attributes uses a message which allows a list of lists. In combination, the two fields allow the composition of this expression:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restricts the search to only those vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle.

Returns:

(::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>) —
Callers can form complex logical operations using any combination of the required_attributes, required_one_of_attributes, and required_one_of_attribute_sets fields.

required_attributes is a list; required_one_of_attributes uses a message which allows a list of lists. In combination, the two fields allow the composition of this expression:
```
(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)
```
Restricts the search to only those vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#required_one_of_attribute_sets ⇒ `::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>`

Returns required_one_of_attribute_sets provides additional functionality.

Similar to required_one_of_attributes, required_one_of_attribute_sets uses a message which allows a list of lists, allowing expressions such as this one:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restricts the search to only those vehicles with all the attributes in a VehicleAttributeList. Within each list, a vehicle must match all of the attributes. This field is a conjunction/AND operation in each VehicleAttributeList and inclusive disjunction/OR operation across the collection of VehicleAttributeList.

Returns:

(::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>) —
required_one_of_attribute_sets provides additional functionality.

Similar to required_one_of_attributes, required_one_of_attribute_sets uses a message which allows a list of lists, allowing expressions such as this one:
```
(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)
```
Restricts the search to only those vehicles with all the attributes in a VehicleAttributeList. Within each list, a vehicle must match all of the attributes. This field is a conjunction/AND operation in each VehicleAttributeList and inclusive disjunction/OR operation across the collection of VehicleAttributeList.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#required_one_of_attributes ⇒ `::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>`

Returns Restricts the search to only those vehicles with at least one of the specified attributes in each VehicleAttributeList. Within each list, a vehicle must match at least one of the attributes. This field is an inclusive disjunction/OR operation in each VehicleAttributeList and a conjunction/AND operation across the collection of VehicleAttributeList.

Returns:

(::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>) —
Restricts the search to only those vehicles with at least one of the specified attributes in each VehicleAttributeList. Within each list, a vehicle must match at least one of the attributes. This field is an inclusive disjunction/OR operation in each VehicleAttributeList and a conjunction/AND operation across the collection of VehicleAttributeList.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#trip_id ⇒ `::String`

Returns Indicates the trip associated with this SearchVehicleRequest.

Returns:

(::String) —
Indicates the trip associated with this SearchVehicleRequest.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#trip_types ⇒ `::Array<::Google::Maps::FleetEngine::V1::TripType>`

Returns Required. Represents the type of proposed trip. Must include exactly one type. UNKNOWN_TRIP_TYPE is not allowed. Restricts the search to only those vehicles that can support that trip type.

Returns:

(::Array<::Google::Maps::FleetEngine::V1::TripType>) —
Required. Represents the type of proposed trip. Must include exactly one type. UNKNOWN_TRIP_TYPE is not allowed. Restricts the search to only those vehicles that can support that trip type.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

#vehicle_types ⇒ `::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType>`

Returns Required. Restricts the search to vehicles with one of the specified types. At least one vehicle type must be specified. VehicleTypes with a category of UNKNOWN are not allowed.

Returns:

(::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType>) —
Required. Restricts the search to vehicles with one of the specified types. At least one vehicle type must be specified. VehicleTypes with a category of UNKNOWN are not allowed.

# File 'proto_docs/google/maps/fleetengine/v1/vehicle_api.rb', line 326

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

  # Specifies the order of the vehicle matches in the response.
  module VehicleMatchOrder
    # Default, used for unspecified or unrecognized vehicle matches order.
    UNKNOWN_VEHICLE_MATCH_ORDER = 0

    # Ascending order by vehicle driving time to the pickup point.
    PICKUP_POINT_ETA = 1

    # Ascending order by vehicle driving distance to the pickup point.
    PICKUP_POINT_DISTANCE = 2

    # Ascending order by vehicle driving time to the dropoff point. This order
    # can only be used if the dropoff point is specified in the request.
    DROPOFF_POINT_ETA = 3

    # Ascending order by straight-line distance from the vehicle's last
    # reported location to the pickup point.
    PICKUP_POINT_STRAIGHT_DISTANCE = 4

    # Ascending order by the configured match cost. Match cost is defined as a
    # weighted calculation between straight-line distance and ETA. Weights are
    # set with default values and can be modified per customer. Please contact
    # Google support if these weights need to be modified for your project.
    COST = 5
  end

  # Specifies the types of restrictions on a vehicle's current trips.
  module CurrentTripsPresent
    # The availability of vehicles with trips present is governed by the
    # `include_back_to_back` field.
    CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0

    # Vehicles without trips can appear in search results. When this value is
    # used, `include_back_to_back` cannot be `true`.
    NONE = 1

    # Vehicles with at most 5 current trips and 10 waypoints are included
    # in the search results. When this value is used, `include_back_to_back`
    # cannot be `true`.
    ANY = 2
  end
end

Class: Google::Maps::FleetEngine::V1::SearchVehiclesRequest

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ ::Integer

#current_trips_present ⇒ ::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::CurrentTripsPresent

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

#filter ⇒ ::String

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

#include_back_to_back ⇒ ::Boolean

#maximum_staleness ⇒ ::Google::Protobuf::Duration

#minimum_capacity ⇒ ::Integer

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

#parent ⇒ ::String

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

#pickup_radius_meters ⇒ ::Integer

#required_attributes ⇒ ::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>

#required_one_of_attribute_sets ⇒ ::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>

#required_one_of_attributes ⇒ ::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>

#trip_id ⇒ ::String

#trip_types ⇒ ::Array<::Google::Maps::FleetEngine::V1::TripType>

#vehicle_types ⇒ ::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType>

#count ⇒ `::Integer`

#current_trips_present ⇒ `::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::CurrentTripsPresent`

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

#filter ⇒ `::String`

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

#include_back_to_back ⇒ `::Boolean`

#maximum_staleness ⇒ `::Google::Protobuf::Duration`

#minimum_capacity ⇒ `::Integer`

#order_by ⇒ `::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder`

#parent ⇒ `::String`

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

#pickup_radius_meters ⇒ `::Integer`

#required_attributes ⇒ `::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>`

#required_one_of_attribute_sets ⇒ `::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>`

#required_one_of_attributes ⇒ `::Array<::Google::Maps::FleetEngine::V1::VehicleAttributeList>`

#trip_id ⇒ `::String`

#trip_types ⇒ `::Array<::Google::Maps::FleetEngine::V1::TripType>`

#vehicle_types ⇒ `::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType>`