Class SearchVehiclesRequest

SearchVehicles request message.

Inheritance
object
SearchVehiclesRequest
Implements
Inherited Members
Namespace: Google.Maps.FleetEngine.V1
Assembly: Google.Maps.FleetEngine.V1.dll
Syntax
public sealed class SearchVehiclesRequest : IMessage<SearchVehiclesRequest>, IEquatable<SearchVehiclesRequest>, IDeepCloneable<SearchVehiclesRequest>, IBufferMessage, IMessage

Constructors

SearchVehiclesRequest()

Declaration
public SearchVehiclesRequest()

SearchVehiclesRequest(SearchVehiclesRequest)

Declaration
public SearchVehiclesRequest(SearchVehiclesRequest other)
Parameters
Type Name Description
SearchVehiclesRequest other

Properties

Count

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

Declaration
public int Count { get; set; }
Property Value
Type Description
int

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.

Declaration
public SearchVehiclesRequest.Types.CurrentTripsPresent CurrentTripsPresent { get; set; }
Property Value
Type Description
SearchVehiclesRequest.Types.CurrentTripsPresent

DropoffPoint

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

Declaration
public TerminalLocation DropoffPoint { get; set; }
Property Value
Type Description
TerminalLocation

Filter

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").

Declaration
public string Filter { get; set; }
Property Value
Type Description
string

Header

The standard Fleet Engine request header.

Declaration
public RequestHeader Header { get; set; }
Property Value
Type Description
RequestHeader

IncludeBackToBack

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.

Declaration
public bool IncludeBackToBack { get; set; }
Property Value
Type Description
bool

MaximumStaleness

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.

Declaration
public Duration MaximumStaleness { get; set; }
Property Value
Type Description
Duration

MinimumCapacity

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.

Declaration
public int MinimumCapacity { get; set; }
Property Value
Type Description
int

OrderBy

Required. Specifies the desired ordering criterion for results.

Declaration
public SearchVehiclesRequest.Types.VehicleMatchOrder OrderBy { get; set; }
Property Value
Type Description
SearchVehiclesRequest.Types.VehicleMatchOrder

Parent

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.

Declaration
public string Parent { get; set; }
Property Value
Type Description
string

PickupPoint

Required. The pickup point to search near.

Declaration
public TerminalLocation PickupPoint { get; set; }
Property Value
Type Description
TerminalLocation

PickupRadiusMeters

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).

Declaration
public int PickupRadiusMeters { get; set; }
Property Value
Type Description
int

RequiredAttributes

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.

Declaration
public RepeatedField<VehicleAttribute> RequiredAttributes { get; }
Property Value
Type Description
RepeatedField<VehicleAttribute>

RequiredOneOfAttributeSets

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.

Declaration
public RepeatedField<VehicleAttributeList> RequiredOneOfAttributeSets { get; }
Property Value
Type Description
RepeatedField<VehicleAttributeList>

RequiredOneOfAttributes

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.

Declaration
public RepeatedField<VehicleAttributeList> RequiredOneOfAttributes { get; }
Property Value
Type Description
RepeatedField<VehicleAttributeList>

TripId

Indicates the trip associated with this SearchVehicleRequest.

Declaration
public string TripId { get; set; }
Property Value
Type Description
string

TripTypes

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.

Declaration
public RepeatedField<TripType> TripTypes { get; }
Property Value
Type Description
RepeatedField<TripType>

VehicleTypes

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.

Declaration
public RepeatedField<Vehicle.Types.VehicleType> VehicleTypes { get; }
Property Value
Type Description
RepeatedField<Vehicle.Types.VehicleType>