Reference documentation and code samples for the Google Maps FleetEngine V1 Client class SearchVehiclesRequest.
SearchVehicles
request message.
Generated from protobuf message maps.fleetengine.v1.SearchVehiclesRequest
Namespace
Google \ Maps \ FleetEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ header
↳ parent
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.
↳ pickup_point
↳ dropoff_point
TerminalLocation
The customer's intended dropoff location. The field is required if trip_types
contains TripType.SHARED
.
↳ pickup_radius_meters
int
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).
↳ count
int
Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive).
↳ minimum_capacity
int
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.
↳ trip_types
array
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.
↳ maximum_staleness
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.
↳ vehicle_types
array< 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.
↳ required_attributes
array< 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<xref uid="\1\">0</xref> OR ...) AND (required_one_of_attributes[1][0] OR required_one_of_attributes<xref uid="\1\">1</xref> 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.
↳ required_one_of_attributes
array< 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
.
↳ required_one_of_attribute_sets
array< 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<xref uid="\1\">0</xref> AND ...) OR (required_one_of_attribute_sets[1][0] AND required_one_of_attribute_sets<xref uid="\1\">1</xref> 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
.
↳ order_by
int
Required. Specifies the desired ordering criterion for results.
↳ include_back_to_back
bool
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
.
↳ trip_id
string
Indicates the trip associated with this SearchVehicleRequest
.
↳ current_trips_present
int
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
.
↳ filter
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"
).
getHeader
The standard Fleet Engine request header.
hasHeader
clearHeader
setHeader
The standard Fleet Engine request header.
$this
getParent
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.
string
setParent
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.
var
string
$this
getPickupPoint
Required. The pickup point to search near.
hasPickupPoint
clearPickupPoint
setPickupPoint
Required. The pickup point to search near.
$this
getDropoffPoint
The customer's intended dropoff location. The field is required if trip_types
contains TripType.SHARED
.
hasDropoffPoint
clearDropoffPoint
setDropoffPoint
The customer's intended dropoff location. The field is required if trip_types
contains TripType.SHARED
.
$this
getPickupRadiusMeters
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).
int
setPickupRadiusMeters
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).
var
int
$this
getCount
Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive).
int
setCount
Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive).
var
int
$this
getMinimumCapacity
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.
int
setMinimumCapacity
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.
var
int
$this
getTripTypes
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.
setTripTypes
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.
var
int[]
$this
getMaximumStaleness
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.
hasMaximumStaleness
clearMaximumStaleness
setMaximumStaleness
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.
$this
getVehicleTypes
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.
setVehicleTypes
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.
$this
getRequiredAttributes
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<xref uid="\1\">0</xref> OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes<xref uid="\1\">1</xref> 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.
setRequiredAttributes
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<xref uid="\1\">0</xref> OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes<xref uid="\1\">1</xref> 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.
$this
getRequiredOneOfAttributes
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
.
setRequiredOneOfAttributes
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
.
$this
getRequiredOneOfAttributeSets
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<xref uid="\1\">0</xref> AND
...)
OR
(required_one_of_attribute_sets[1][0] AND
required_one_of_attribute_sets<xref uid="\1\">1</xref> 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
.
setRequiredOneOfAttributeSets
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<xref uid="\1\">0</xref> AND
...)
OR
(required_one_of_attribute_sets[1][0] AND
required_one_of_attribute_sets<xref uid="\1\">1</xref> 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
.
$this
getOrderBy
Required. Specifies the desired ordering criterion for results.
int
setOrderBy
Required. Specifies the desired ordering criterion for results.
var
int
$this
getIncludeBackToBack
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
.
bool
setIncludeBackToBack
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
.
var
bool
$this
getTripId
Indicates the trip associated with this SearchVehicleRequest
.
string
setTripId
Indicates the trip associated with this SearchVehicleRequest
.
var
string
$this
getCurrentTripsPresent
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
.
int
setCurrentTripsPresent
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
.
var
int
$this
getFilter
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"
).
string
setFilter
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"
).
var
string
$this
