google-maps-fleet_engine-v1 0.a → 0.2.0

data/proto_docs/google/maps/fleetengine/v1/vehicle_api.rb

@@ -0,0 +1,659 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Maps
+    module FleetEngine
+      module V1
+        # `CreateVehicle` request message.
+        # @!attribute [rw] header
+        #   @return [::Google::Maps::FleetEngine::V1::RequestHeader]
+        #     The standard Fleet Engine request header.
+        # @!attribute [rw] parent
+        #   @return [::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.
+        # @!attribute [rw] vehicle_id
+        #   @return [::String]
+        #     Required. Unique Vehicle ID.
+        #     Subject to the following restrictions:
+        #
+        #     * Must be a valid Unicode string.
+        #     * Limited to a maximum length of 64 characters.
+        #     * Normalized according to [Unicode Normalization Form C]
+        #     (http://www.unicode.org/reports/tr15/).
+        #     * May not contain any of the following ASCII characters: '/', ':', '?',
+        #     ',', or '#'.
+        # @!attribute [rw] vehicle
+        #   @return [::Google::Maps::FleetEngine::V1::Vehicle]
+        #     Required. The Vehicle entity to create. When creating a Vehicle, the
+        #     following fields are required:
+        #
+        #     * `vehicleState`
+        #     * `supportedTripTypes`
+        #     * `maximumCapacity`
+        #     * `vehicleType`
+        #
+        #     When creating a Vehicle, the following fields are ignored:
+        #
+        #     * `name`
+        #     * `currentTrips`
+        #     * `availableCapacity`
+        #     * `current_route_segment`
+        #     * `current_route_segment_end_point`
+        #     * `current_route_segment_version`
+        #     * `current_route_segment_traffic`
+        #     * `route`
+        #     * `waypoints`
+        #     * `waypoints_version`
+        #     * `remaining_distance_meters`
+        #     * `remaining_time_seconds`
+        #     * `eta_to_next_waypoint`
+        #     * `navigation_status`
+        #
+        #     All other fields are optional and used if provided.
+        class CreateVehicleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `GetVehicle` request message.
+        # @!attribute [rw] header
+        #   @return [::Google::Maps::FleetEngine::V1::RequestHeader]
+        #     The standard Fleet Engine request header.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Must be in the format
+        #     `providers/{provider}/vehicles/{vehicle}`.
+        #     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.
+        # @!attribute [rw] current_route_segment_version
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Indicates the minimum timestamp (exclusive) for which
+        #     `Vehicle.current_route_segment` is retrieved.
+        #     If the route is unchanged since this timestamp, the `current_route_segment`
+        #     field is not set in the response. If a minimum is unspecified, the
+        #     `current_route_segment` is always retrieved.
+        # @!attribute [rw] waypoints_version
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Indicates the minimum timestamp (exclusive) for which `Vehicle.waypoints`
+        #     data is retrieved. If the waypoints are unchanged since this timestamp, the
+        #     `vehicle.waypoints` data is not set in the response. If this field is
+        #     unspecified, `vehicle.waypoints` is always retrieved.
+        class GetVehicleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `UpdateVehicle request message.
+        # @!attribute [rw] header
+        #   @return [::Google::Maps::FleetEngine::V1::RequestHeader]
+        #     The standard Fleet Engine request header.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Must be in the format
+        #     `providers/{provider}/vehicles/{vehicle}`.
+        #     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.
+        # @!attribute [rw] vehicle
+        #   @return [::Google::Maps::FleetEngine::V1::Vehicle]
+        #     Required. The `Vehicle` entity values to apply.  When updating a `Vehicle`,
+        #     the following fields may not be updated as they are managed by the
+        #     server.
+        #
+        #     * `available_capacity`
+        #     * `current_route_segment_version`
+        #     * `current_trips`
+        #     * `name`
+        #     * `waypoints_version`
+        #
+        #     If the `attributes` field is updated, **all** the vehicle's attributes are
+        #     replaced with the attributes provided in the request. If you want to update
+        #     only some attributes, see the `UpdateVehicleAttributes` method.
+        #
+        #     Likewise, the `waypoints` field can be updated, but must contain all the
+        #     waypoints currently on the vehicle, and no other waypoints.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. A field mask indicating which fields of the `Vehicle` to update.
+        #     At least one field name must be provided.
+        class UpdateVehicleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `UpdateVehicleAttributes` request message.
+        # @!attribute [rw] header
+        #   @return [::Google::Maps::FleetEngine::V1::RequestHeader]
+        #     The standard Fleet Engine request header.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Must be in the format `providers/{provider}/vehicles/{vehicle}`.
+        #     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.
+        # @!attribute [rw] attributes
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>]
+        #     Required. The vehicle attributes to update. Unmentioned attributes are not
+        #     altered or removed.
+        class UpdateVehicleAttributesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `UpdateVehicleAttributes` response message.
+        # @!attribute [rw] attributes
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>]
+        #     Required. The updated full list of vehicle attributes, including new,
+        #     altered, and untouched attributes.
+        class UpdateVehicleAttributesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `SearchVehicles` request message.
+        # @!attribute [rw] header
+        #   @return [::Google::Maps::FleetEngine::V1::RequestHeader]
+        #     The standard Fleet Engine request header.
+        # @!attribute [rw] parent
+        #   @return [::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.
+        # @!attribute [rw] pickup_point
+        #   @return [::Google::Maps::FleetEngine::V1::TerminalLocation]
+        #     Required. The pickup point to search near.
+        # @!attribute [rw] dropoff_point
+        #   @return [::Google::Maps::FleetEngine::V1::TerminalLocation]
+        #     The customer's intended dropoff location. The field is required if
+        #     `trip_types` contains `TripType.SHARED`.
+        # @!attribute [rw] pickup_radius_meters
+        #   @return [::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).
+        # @!attribute [rw] count
+        #   @return [::Integer]
+        #     Required. Specifies the maximum number of vehicles to return. The value
+        #     must be between 1 and 50 (inclusive).
+        # @!attribute [rw] minimum_capacity
+        #   @return [::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.
+        # @!attribute [rw] trip_types
+        #   @return [::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.
+        # @!attribute [rw] maximum_staleness
+        #   @return [::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.
+        # @!attribute [rw] vehicle_types
+        #   @return [::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.
+        # @!attribute [rw] required_attributes
+        #   @return [::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.
+        # @!attribute [rw] required_one_of_attributes
+        #   @return [::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`.
+        # @!attribute [rw] required_one_of_attribute_sets
+        #   @return [::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`.
+        # @!attribute [rw] order_by
+        #   @return [::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder]
+        #     Required. Specifies the desired ordering criterion for results.
+        # @!attribute [rw] include_back_to_back
+        #   @return [::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`.
+        # @!attribute [rw] trip_id
+        #   @return [::String]
+        #     Indicates the trip associated with this `SearchVehicleRequest`.
+        # @!attribute [rw] current_trips_present
+        #   @return [::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`.
+        # @!attribute [rw] filter
+        #   @return [::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"`).
+        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
+
+        # `SearchVehicles` response message.
+        # @!attribute [rw] matches
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::VehicleMatch>]
+        #     List of vehicles that match the `SearchVehiclesRequest` criteria, ordered
+        #     according to `SearchVehiclesRequest.order_by` field.
+        class SearchVehiclesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `ListVehicles` request message.
+        # @!attribute [rw] header
+        #   @return [::Google::Maps::FleetEngine::V1::RequestHeader]
+        #     The standard Fleet Engine request header.
+        # @!attribute [rw] parent
+        #   @return [::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.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of vehicles to return.
+        #     Default value: 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The value of the `next_page_token` provided by a previous call to
+        #     `ListVehicles` so that you can paginate through groups of vehicles. The
+        #     value is undefined if the filter criteria of the request is not the same as
+        #     the filter criteria for the previous call to `ListVehicles`.
+        # @!attribute [rw] minimum_capacity
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Specifies the required minimum capacity of the vehicle. All vehicles
+        #     returned will have a `maximum_capacity` greater than or equal to this
+        #     value. If set, must be greater or equal to 0.
+        # @!attribute [rw] trip_types
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::TripType>]
+        #     Restricts the response to vehicles that support at least one of the
+        #     specified trip types.
+        # @!attribute [rw] maximum_staleness
+        #   @return [::Google::Protobuf::Duration]
+        #     Restricts the response to vehicles that have sent location updates to Fleet
+        #     Engine within the specified duration. Stationary vehicles still
+        #     transmitting their locations are not considered stale. If present, must be
+        #     a valid positive duration.
+        # @!attribute [rw] vehicle_type_categories
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::Vehicle::VehicleType::Category>]
+        #     Required. Restricts the response to vehicles with one of the specified type
+        #     categories. `UNKNOWN` is not allowed.
+        # @!attribute [rw] required_attributes
+        #   @return [::Array<::String>]
+        #     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 response to 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. Each repeated string should be of the format "key:value".
+        # @!attribute [rw] required_one_of_attributes
+        #   @return [::Array<::String>]
+        #     Restricts the response to 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`.
+        #     Each repeated string should be of the format
+        #     "key1:value1|key2:value2|key3:value3".
+        # @!attribute [rw] required_one_of_attribute_sets
+        #   @return [::Array<::String>]
+        #     `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 response to vehicles that match 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`. Each repeated string should be of the
+        #     format "key1:value1|key2:value2|key3:value3".
+        # @!attribute [rw] vehicle_state
+        #   @return [::Google::Maps::FleetEngine::V1::VehicleState]
+        #     Restricts the response to vehicles that have this vehicle state.
+        # @!attribute [rw] on_trip_only
+        #   @return [::Boolean]
+        #     Only return the vehicles with current trip(s).
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter query to apply when listing 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 `vehicle_state` or `on_trip_only`.
+        #
+        #     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"`).
+        # @!attribute [rw] viewport
+        #   @return [::Google::Geo::Type::Viewport]
+        #     Optional. A filter that limits the vehicles returned to those whose last
+        #     known location was in the rectangular area defined by the viewport.
+        class ListVehiclesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `ListVehicles` response message.
+        # @!attribute [rw] vehicles
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::Vehicle>]
+        #     Vehicles matching the criteria in the request.
+        #     The maximum number of vehicles returned is determined by the `page_size`
+        #     field in the request.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of vehicles, or empty if there are no
+        #     more vehicles that meet the request criteria.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     Required. Total number of vehicles matching the request criteria across all
+        #     pages.
+        class ListVehiclesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes intermediate points along a route for a `VehicleMatch` in a
+        # `SearchVehiclesResponse`. This concept is represented as a `TripWaypoint` in
+        # all other endpoints.
+        # @!attribute [rw] lat_lng
+        #   @return [::Google::Type::LatLng]
+        #     The location of this waypoint.
+        # @!attribute [rw] eta
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The estimated time that the vehicle will arrive at this waypoint.
+        class Waypoint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Contains the vehicle and related estimates for a vehicle that match the
+        # points of active trips for the vehicle `SearchVehiclesRequest`.
+        # @!attribute [rw] vehicle
+        #   @return [::Google::Maps::FleetEngine::V1::Vehicle]
+        #     Required. A vehicle that matches the request.
+        # @!attribute [rw] vehicle_pickup_eta
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The vehicle's driving ETA to the pickup point specified in the
+        #     request. An empty value indicates a failure in calculating ETA for the
+        #     vehicle.  If `SearchVehiclesRequest.include_back_to_back` was `true` and
+        #     this vehicle has an active trip, `vehicle_pickup_eta` includes the time
+        #     required to complete the current active trip.
+        # @!attribute [rw] vehicle_pickup_distance_meters
+        #   @return [::Google::Protobuf::Int32Value]
+        #     The distance from the Vehicle's current location to the pickup point
+        #     specified in the request, including any intermediate pickup or dropoff
+        #     points for existing trips. This distance comprises the calculated driving
+        #     (route) distance, plus the straight line distance between the navigation
+        #     end point and the requested pickup point. (The distance between the
+        #     navigation end point and the requested pickup point is typically small.) An
+        #     empty value indicates an error in calculating the distance.
+        # @!attribute [rw] vehicle_pickup_straight_line_distance_meters
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Required. The straight-line distance between the vehicle and the pickup
+        #     point specified in the request.
+        # @!attribute [rw] vehicle_dropoff_eta
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The complete vehicle's driving ETA to the drop off point specified in the
+        #     request. The ETA includes stopping at any waypoints before the
+        #     `dropoff_point` specified in the request. The value will only be populated
+        #     when a drop off point is specified in the request. An empty value indicates
+        #     an error calculating the ETA.
+        # @!attribute [rw] vehicle_pickup_to_dropoff_distance_meters
+        #   @return [::Google::Protobuf::Int32Value]
+        #     The vehicle's driving distance (in meters) from the pickup point
+        #     to the drop off point specified in the request. The distance is only
+        #     between the two points and does not include the vehicle location or any
+        #     other points that must be visited before the vehicle visits either the
+        #     pickup point or dropoff point. The value will only be populated when a
+        #     `dropoff_point` is specified in the request. An empty value indicates
+        #     a failure in calculating the distance from the pickup to
+        #     drop off point specified in the request.
+        # @!attribute [rw] trip_type
+        #   @return [::Google::Maps::FleetEngine::V1::TripType]
+        #     Required. The trip type of the request that was used to calculate the ETA
+        #     to the pickup point.
+        # @!attribute [rw] vehicle_trips_waypoints
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::Waypoint>]
+        #     The ordered list of waypoints used to calculate the ETA. The list
+        #     includes vehicle location, the pickup points of active
+        #     trips for the vehicle, and the pickup points provided in the
+        #     request. An empty list indicates a failure in calculating ETA for the
+        #     vehicle.
+        # @!attribute [rw] vehicle_match_type
+        #   @return [::Google::Maps::FleetEngine::V1::VehicleMatch::VehicleMatchType]
+        #     Type of the vehicle match.
+        # @!attribute [rw] requested_ordered_by
+        #   @return [::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder]
+        #     The order requested for sorting vehicle matches.
+        # @!attribute [rw] ordered_by
+        #   @return [::Google::Maps::FleetEngine::V1::SearchVehiclesRequest::VehicleMatchOrder]
+        #     The actual order that was used for this vehicle. Normally this
+        #     will match the 'order_by' field from the request; however, in certain
+        #     circumstances such as an internal server error, a different method
+        #     may be used (such as `PICKUP_POINT_STRAIGHT_DISTANCE`).
+        class VehicleMatch
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Type of vehicle match.
+          module VehicleMatchType
+            # Unknown vehicle match type
+            UNKNOWN = 0
+
+            # The vehicle currently has no trip assigned to it and can proceed to the
+            # pickup point.
+            EXCLUSIVE = 1
+
+            # The vehicle is currently assigned to a trip, but can proceed to the
+            # pickup point after completing the in-progress trip.  ETA and distance
+            # calculations take the existing trip into account.
+            BACK_TO_BACK = 2
+
+            # The vehicle has sufficient capacity for a shared ride.
+            CARPOOL = 3
+
+            # The vehicle will finish its current, active trip before proceeding to the
+            # pickup point.  ETA and distance calculations take the existing trip into
+            # account.
+            CARPOOL_BACK_TO_BACK = 4
+          end
+        end
+
+        # A list-of-lists datatype for vehicle attributes.
+        # @!attribute [rw] attributes
+        #   @return [::Array<::Google::Maps::FleetEngine::V1::VehicleAttribute>]
+        #     A list of attributes in this collection.
+        class VehicleAttributeList
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end