@@ -350,14 +350,10 @@ class SearchVehiclesRequest(proto.Message):
350
350
greater than or equal to one. The driver is not
351
351
considered in the capacity value.
352
352
trip_types (MutableSequence[google.maps.fleetengine_v1.types.TripType]):
353
- Required. Represents the type of proposed trip. Eligible
354
- vehicles are those that can support at least one of the
355
- specified trip type.
356
-
357
- ``EXCLUSIVE`` and ``SHARED`` may not be included together.
358
- ``SHARED`` is not supported when ``current_trips_present``
359
- is ``CURRENT_TRIPS_PRESENT_UNSPECIFIED``.
360
- ``UNKNOWN_TRIP_TYPE`` is not allowed.
353
+ Required. Represents the type of proposed trip. Must include
354
+ exactly one type. ``UNKNOWN_TRIP_TYPE`` is not allowed.
355
+ Restricts the search to only those vehicles that can support
356
+ that trip type.
361
357
maximum_staleness (google.protobuf.duration_pb2.Duration):
362
358
Restricts the search to only those vehicles
363
359
that have sent location updates to Fleet Engine
@@ -438,26 +434,26 @@ class SearchVehiclesRequest(proto.Message):
438
434
Required. Specifies the desired ordering
439
435
criterion for results.
440
436
include_back_to_back (bool):
441
- Indicates if a vehicle with a single active trip is eligible
442
- for another match. If ``false``, vehicles with assigned
443
- trips are excluded from the search results. If ``true``,
444
- search results include vehicles with ``TripStatus`` of
445
- ``ENROUTE_TO_DROPOFF``.
446
-
447
- This field is only considered if a single ``trip_type`` of
448
- ``EXCLUSIVE`` is specified.
437
+ This indicates if vehicles with a single active trip are
438
+ eligible for this search. This field is only used when
439
+ ``current_trips_present`` is unspecified. When
440
+ ``current_trips_present`` is unspecified and this field is
441
+ ``false``, vehicles with assigned trips are excluded from
442
+ the search results. When ``current_trips_present`` is
443
+ unspecified and this field is ``true``, search results can
444
+ include vehicles with one active trip that has a status of
445
+ ``ENROUTE_TO_DROPOFF``. When ``current_trips_present`` is
446
+ specified, this field cannot be set to true.
449
447
450
448
The default value is ``false``.
451
449
trip_id (str):
452
450
Indicates the trip associated with this
453
451
``SearchVehicleRequest``.
454
452
current_trips_present (google.maps.fleetengine_v1.types.SearchVehiclesRequest.CurrentTripsPresent):
455
- Restricts vehicles from appearing in the search results
456
- based on their current trips.
457
-
458
- When current_trips_present is ``NONE`` or ``ANY``,
459
- ``trip_types`` can be either ``EXCLUSIVE`` or ``SHARED``,
460
- but not both.
453
+ This indicates if vehicles with active trips are eligible
454
+ for this search. This must be set to something other than
455
+ ``CURRENT_TRIPS_PRESENT_UNSPECIFIED`` if ``trip_type``
456
+ includes ``SHARED``.
461
457
filter (str):
462
458
Optional. A filter query to apply when searching vehicles.
463
459
See http://aip.dev/160 for examples of the filter syntax.
@@ -531,18 +527,16 @@ class CurrentTripsPresent(proto.Enum):
531
527
532
528
Values:
533
529
CURRENT_TRIPS_PRESENT_UNSPECIFIED (0):
534
- Only vehicles without trips can appear in search results. A
535
- validation exception is thrown if ``include_back_to_back``
536
- is true. See the ``include_back_to_back`` flag for more
537
- details.
530
+ The availability of vehicles with trips present is governed
531
+ by the ``include_back_to_back`` field.
538
532
NONE (1):
539
- Vehicles without trips can appear in search results. A
540
- validation exception is thrown if ``include_back_to_back``
541
- is true.
533
+ Vehicles without trips can appear in search results. When
534
+ this value is used, ``include_back_to_back`` cannot be
535
+ `` true`` .
542
536
ANY (2):
543
537
Vehicles with at most 5 current trips and 10 waypoints are
544
- included in the search results. A validation exception is
545
- thrown if ``include_back_to_back`` is true.
538
+ included in the search results. When this value is used,
539
+ ``include_back_to_back`` cannot be `` true`` .
546
540
"""
547
541
CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0
548
542
NONE = 1
0 commit comments