Skip to content

Commit 9ef70f7

Browse files
docs: [google-maps-fleetengine] better comments on SearchVehicle fields (#12186)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 597589941 Source-Link: googleapis/googleapis@354ab53 Source-Link: googleapis/googleapis-gen@130a621 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtZmxlZXRlbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6IjEzMGE2MjExYWY3OTI4YTM1NzVmZWQyMzJiMjYxY2E3MGFhMzU5ZmIifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 96029ae commit 9ef70f7

File tree

4 files changed

+28
-34
lines changed

4 files changed

+28
-34
lines changed

packages/google-maps-fleetengine/google/maps/fleetengine/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.3" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-maps-fleetengine/google/maps/fleetengine_v1/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.3" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-maps-fleetengine/google/maps/fleetengine_v1/types/vehicle_api.py

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -350,14 +350,10 @@ class SearchVehiclesRequest(proto.Message):
350350
greater than or equal to one. The driver is not
351351
considered in the capacity value.
352352
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.
361357
maximum_staleness (google.protobuf.duration_pb2.Duration):
362358
Restricts the search to only those vehicles
363359
that have sent location updates to Fleet Engine
@@ -438,26 +434,26 @@ class SearchVehiclesRequest(proto.Message):
438434
Required. Specifies the desired ordering
439435
criterion for results.
440436
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.
449447
450448
The default value is ``false``.
451449
trip_id (str):
452450
Indicates the trip associated with this
453451
``SearchVehicleRequest``.
454452
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``.
461457
filter (str):
462458
Optional. A filter query to apply when searching vehicles.
463459
See http://aip.dev/160 for examples of the filter syntax.
@@ -531,18 +527,16 @@ class CurrentTripsPresent(proto.Enum):
531527
532528
Values:
533529
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.
538532
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``.
542536
ANY (2):
543537
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``.
546540
"""
547541
CURRENT_TRIPS_PRESENT_UNSPECIFIED = 0
548542
NONE = 1

packages/google-maps-fleetengine/samples/generated_samples/snippet_metadata_maps.fleetengine.v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"language": "PYTHON",
1010
"name": "google-maps-fleetengine",
11-
"version": "0.1.3"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)