google-maps-fleet_engine-delivery-v1 0.a → 0.1.0

data/proto_docs/google/maps/fleetengine/delivery/v1/delivery_vehicles.rb

@@ -0,0 +1,271 @@
+# 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 Delivery
+        module V1
+          # The `DeliveryVehicle` message. A delivery vehicle transports shipments from a
+          # depot to a delivery location, and from a pickup location to the depot. In
+          # some cases, delivery vehicles also transport shipments directly from the
+          # pickup location to the delivery location.
+          #
+          # Note: gRPC and REST APIs use different field naming conventions. For example,
+          # the `DeliveryVehicle.current_route_segment` field in the gRPC API and the
+          # `DeliveryVehicle.currentRouteSegment` field in the REST API refer to the same
+          # field.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique name of this Delivery Vehicle.
+          #     The format is `providers/{provider}/deliveryVehicles/{vehicle}`.
+          # @!attribute [rw] last_location
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocation]
+          #     The last reported location of the Delivery Vehicle.
+          # @!attribute [rw] navigation_status
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleNavigationStatus]
+          #     The Delivery Vehicle's navigation status.
+          # @!attribute [rw] current_route_segment
+          #   @return [::String]
+          #     The encoded polyline specifying the route that the navigation recommends
+          #     taking to the next waypoint. Your driver app updates this when a
+          #     stop is reached or passed, and when the navigation reroutes. These
+          #     `LatLng`s are returned in
+          #     `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
+          #     (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
+          #     (REST) for all active Tasks assigned to the Vehicle.
+          #
+          #     There are a few cases where this field might not be used to populate
+          #     `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
+          #     (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
+          #     (REST):
+          #
+          #     * The endpoint of the `current_route_segment` does not match
+          #     `DeliveryVehicle.remaining_vehicle_journey_segments[0].stop` (gRPC) or
+          #     `DeliveryVehicle.remainingVehicleJourneySegments[0].stop` (REST).
+          #
+          #     * The driver app has not updated its location recently, so the last
+          #     updated value for this field might be stale.
+          #
+          #     * The driver app has recently updated its location, but the
+          #     `current_route_segment` is stale, and points to a previous vehicle stop.
+          #
+          #     In these cases, Fleet Engine populates this field with a route from the
+          #     most recently passed VehicleStop to the upcoming VehicleStop to ensure that
+          #     the consumer of this field has the best available information on the
+          #     current path of the Delivery Vehicle.
+          # @!attribute [rw] current_route_segment_end_point
+          #   @return [::Google::Type::LatLng]
+          #     The location where the `current_route_segment` ends. This is not currently
+          #     populated by the driver app, but you can supply it on
+          #     `UpdateDeliveryVehicle` calls. It is either the `LatLng` from the upcoming
+          #     vehicle stop, or the last `LatLng` of the `current_route_segment`. Fleet
+          #     Engine will then do its best to interpolate to an actual `VehicleStop`.
+          #
+          #     This field is ignored in `UpdateDeliveryVehicle` calls if the
+          #     `current_route_segment` field is empty.
+          # @!attribute [rw] remaining_distance_meters
+          #   @return [::Google::Protobuf::Int32Value]
+          #     The remaining driving distance for the `current_route_segment`.
+          #     The Driver app typically provides this field, but there are some
+          #     circumstances in which Fleet Engine will override the value sent by the
+          #     app. For more information, see
+          #     {::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle#current_route_segment DeliveryVehicle.current_route_segment}.
+          #     This field is returned in
+          #     `Task.remaining_vehicle_journey_segments[0].driving_distance_meters` (gRPC)
+          #     or `Task.remainingVehicleJourneySegments[0].drivingDistanceMeters` (REST)
+          #     for all active `Task`s assigned to the Delivery Vehicle.
+          #
+          #     Fleet Engine ignores this field in `UpdateDeliveryVehicleRequest` if the
+          #     `current_route_segment` field is empty.
+          # @!attribute [rw] remaining_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     The remaining driving time for the `current_route_segment`.
+          #     The Driver app typically provides this field, but there are some
+          #     circumstances in which Fleet Engine will override the value sent by the
+          #     app.  For more information, see
+          #     {::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle#current_route_segment DeliveryVehicle.current_route_segment}.
+          #     This field is returned in
+          #     `Task.remaining_vehicle_journey_segments[0].driving_duration` (gRPC) or
+          #     `Task.remainingVehicleJourneySegments[0].drivingDuration` (REST) for all
+          #     active tasks assigned to the Delivery Vehicle.
+          #
+          #     Fleet Engine ignores this field in `UpdateDeliveryVehicleRequest` if the
+          #     `current_route_segment` field is empty.
+          # @!attribute [rw] remaining_vehicle_journey_segments
+          #   @return [::Array<::Google::Maps::FleetEngine::Delivery::V1::VehicleJourneySegment>]
+          #     The journey segments assigned to this Delivery Vehicle, starting from the
+          #     Vehicle's most recently reported location. This field won't be populated
+          #     in the response of `ListDeliveryVehicles`.
+          # @!attribute [rw] attributes
+          #   @return [::Array<::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleAttribute>]
+          #     A list of custom Delivery Vehicle attributes. A Delivery Vehicle can have
+          #     at most 100 attributes, and each attribute must have a unique key.
+          # @!attribute [rw] type
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle::DeliveryVehicleType]
+          #     The type of this delivery vehicle. If unset, this will default to `AUTO`.
+          class DeliveryVehicle
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of delivery vehicle.
+            module DeliveryVehicleType
+              # The value is unused.
+              DELIVERY_VEHICLE_TYPE_UNSPECIFIED = 0
+
+              # An automobile.
+              AUTO = 1
+
+              # A motorcycle, moped, or other two-wheeled vehicle
+              TWO_WHEELER = 2
+
+              # Human-powered transport.
+              BICYCLE = 3
+
+              # A human transporter, typically walking or running, traveling along
+              # pedestrian pathways.
+              PEDESTRIAN = 4
+            end
+          end
+
+          # A location with any additional identifiers.
+          # @!attribute [rw] point
+          #   @return [::Google::Type::LatLng]
+          #     The location's coordinates.
+          class LocationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a Vehicle’s travel segment - from its previous stop to the
+          # current stop. If it is the first active stop, then it is from the
+          # Vehicle’s current location to this stop.
+          # @!attribute [rw] stop
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::VehicleStop]
+          #     Specifies the stop location, along with the `Task`s associated with
+          #     the stop. Some fields of the VehicleStop might not be present if this
+          #     journey segment is part of `JourneySharingInfo`.
+          # @!attribute [r] driving_distance_meters
+          #   @return [::Google::Protobuf::Int32Value]
+          #     Output only. The travel distance from the previous stop to this stop.
+          #     If the current stop is the first stop in the list of journey
+          #     segments, then the starting point is the vehicle's location recorded
+          #     at the time that this stop was added to the list. This field might not be
+          #     present if this journey segment is part of `JourneySharingInfo`.
+          # @!attribute [r] driving_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Output only. The travel time from the previous stop to this stop.
+          #     If the current stop is the first stop in the list of journey
+          #     segments, then the starting point is the Vehicle's location recorded
+          #     at the time that this stop was added to the list.
+          #
+          #     If this field is defined in the path
+          #     `Task.remaining_vehicle_journey_segments[0].driving_duration` (gRPC) or
+          #     `Task.remainingVehicleJourneySegments[0].drivingDuration` (REST),
+          #     then it may be populated with the value from
+          #     `DeliveryVehicle.remaining_duration` (gRPC) or
+          #     `DeliveryVehicle.remainingDuration` (REST).
+          #     This provides the remaining driving duration from the driver app's latest
+          #     known location rather than the driving time from the previous stop.
+          # @!attribute [r] path
+          #   @return [::Array<::Google::Type::LatLng>]
+          #     Output only. The path from the previous stop to this stop. If the current
+          #     stop is the first stop in the list of journey segments, then this is the
+          #     path from the vehicle's current location to this stop at the time that the
+          #     stop was added to the list. This field might not be present if this journey
+          #     segment is part of `JourneySharingInfo`.
+          #
+          #     If this field is defined in the path
+          #     `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
+          #     (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
+          #     (REST), then it may be populated with the `LatLng`s decoded from
+          #     `DeliveryVehicle.current_route_segment` (gRPC) or
+          #     `DeliveryVehicle.currentRouteSegment` (REST). This provides the driving
+          #     path from the driver app's latest known location rather than the path from
+          #     the previous stop.
+          class VehicleJourneySegment
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes a point where a Vehicle stops to perform one or more `Task`s.
+          # @!attribute [rw] planned_location
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::LocationInfo]
+          #     Required. The location of the stop. Note that the locations in the `Task`s
+          #     might not exactly match this location, but will be within a short distance
+          #     of it. This field won't be populated in the response of either a `GetTask`,
+          #     or a `SearchTasks` call.
+          # @!attribute [rw] tasks
+          #   @return [::Array<::Google::Maps::FleetEngine::Delivery::V1::VehicleStop::TaskInfo>]
+          #     The list of `Task`s to be performed at this stop. This field won't be
+          #     populated in the response of either a `GetTask` or `SearchTasks` call.
+          # @!attribute [rw] state
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::VehicleStop::State]
+          #     The state of the `VehicleStop`. This field won't be populated in the
+          #     response of either a `GetTask`, or a `SearchTasks` call.
+          class VehicleStop
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Additional information about the Task performed at this stop.
+            # @!attribute [rw] task_id
+            #   @return [::String]
+            #     The Task ID. This field won't be populated in the response of either a
+            #     `GetTask`, or a `SearchTasks` call. Task IDs are 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 [r] task_duration
+            #   @return [::Google::Protobuf::Duration]
+            #     Output only. The time required to perform the Task.
+            # @!attribute [r] target_time_window
+            #   @return [::Google::Maps::FleetEngine::Delivery::V1::TimeWindow]
+            #     Output only. The time window during which the task should be completed.
+            #     This is only set in the response to `GetDeliveryVehicle`.
+            class TaskInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The current state of a `VehicleStop`.
+            module State
+              # Unknown.
+              STATE_UNSPECIFIED = 0
+
+              # Created, but not actively routing.
+              NEW = 1
+
+              # Assigned and actively routing.
+              ENROUTE = 2
+
+              # Arrived at stop. Assumes that when the Vehicle is routing to the next
+              # stop, that all previous stops have been completed.
+              ARRIVED = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/maps/fleetengine/delivery/v1/header.rb

@@ -0,0 +1,113 @@
+# 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 Delivery
+        module V1
+          # A RequestHeader contains fields common to all Delivery RPC requests.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The BCP-47 language code, such as en-US or sr-Latn. For more information,
+          #     see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none
+          #     is specified, the response may be in any language, with a preference for
+          #     English if such a name exists. Field value example: `en-US`.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Required. CLDR region code of the region where the request originates.
+          #     Field value example: `US`.
+          # @!attribute [rw] sdk_version
+          #   @return [::String]
+          #     Version of the calling SDK, if applicable.
+          #     The version format is "major.minor.patch", example: `1.1.2`.
+          # @!attribute [rw] os_version
+          #   @return [::String]
+          #     Version of the operating system on which the calling SDK is running.
+          #     Field value examples: `4.4.1`, `12.1`.
+          # @!attribute [rw] device_model
+          #   @return [::String]
+          #     Model of the device on which the calling SDK is running.
+          #     Field value examples: `iPhone12,1`, `SM-G920F`.
+          # @!attribute [rw] sdk_type
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryRequestHeader::SdkType]
+          #     The type of SDK sending the request.
+          # @!attribute [rw] maps_sdk_version
+          #   @return [::String]
+          #     Version of the MapSDK which the calling SDK depends on, if applicable.
+          #     The version format is "major.minor.patch", example: `5.2.1`.
+          # @!attribute [rw] nav_sdk_version
+          #   @return [::String]
+          #     Version of the NavSDK which the calling SDK depends on, if applicable.
+          #     The version format is "major.minor.patch", example: `2.1.0`.
+          # @!attribute [rw] platform
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryRequestHeader::Platform]
+          #     Platform of the calling SDK.
+          # @!attribute [rw] manufacturer
+          #   @return [::String]
+          #     Manufacturer of the Android device from the calling SDK, only applicable
+          #     for the Android SDKs.
+          #     Field value example: `Samsung`.
+          # @!attribute [rw] android_api_level
+          #   @return [::Integer]
+          #     Android API level of the calling SDK, only applicable for the Android SDKs.
+          #     Field value example: `23`.
+          # @!attribute [rw] trace_id
+          #   @return [::String]
+          #     Optional ID that can be provided for logging purposes in order to identify
+          #     the request.
+          class DeliveryRequestHeader
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Possible types of SDK.
+            module SdkType
+              # The default value. This value is used if the `sdk_type` is omitted.
+              SDK_TYPE_UNSPECIFIED = 0
+
+              # The calling SDK is Consumer.
+              CONSUMER = 1
+
+              # The calling SDK is Driver.
+              DRIVER = 2
+
+              # The calling SDK is JavaScript.
+              JAVASCRIPT = 3
+            end
+
+            # The platform of the calling SDK.
+            module Platform
+              # The default value. This value is used if the platform is omitted.
+              PLATFORM_UNSPECIFIED = 0
+
+              # The request is coming from Android.
+              ANDROID = 1
+
+              # The request is coming from iOS.
+              IOS = 2
+
+              # The request is coming from the web.
+              WEB = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb

@@ -0,0 +1,91 @@
+# 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 Delivery
+        module V1
+          # The `TaskTrackingInfo` message. The message contains task tracking
+          # information which will be used for display. If a tracking ID is associated
+          # with multiple Tasks, Fleet Engine uses a heuristic to decide which Task's
+          # TaskTrackingInfo to select.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Must be in the format `providers/{provider}/taskTrackingInfo/{tracking}`,
+          #     where `tracking` represents the tracking ID.
+          # @!attribute [rw] tracking_id
+          #   @return [::String]
+          #     Immutable. The tracking ID of a Task.
+          #     * 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_location
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocation]
+          #     The vehicle's last location.
+          # @!attribute [rw] route_polyline_points
+          #   @return [::Array<::Google::Type::LatLng>]
+          #     A list of points which when connected forms a polyline of the vehicle's
+          #     expected route to the location of this task.
+          # @!attribute [rw] remaining_stop_count
+          #   @return [::Google::Protobuf::Int32Value]
+          #     Indicates the number of stops the vehicle remaining until the task stop is
+          #     reached, including the task stop. For example, if the vehicle's next stop
+          #     is the task stop, the value will be 1.
+          # @!attribute [rw] remaining_driving_distance_meters
+          #   @return [::Google::Protobuf::Int32Value]
+          #     The total remaining distance in meters to the `VehicleStop` of interest.
+          # @!attribute [rw] estimated_arrival_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp that indicates the estimated arrival time to the stop
+          #     location.
+          # @!attribute [rw] estimated_task_completion_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp that indicates the estimated completion time of a Task.
+          # @!attribute [rw] state
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::State]
+          #     The current execution state of the Task.
+          # @!attribute [rw] task_outcome
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::TaskOutcome]
+          #     The outcome of attempting to execute a Task.
+          # @!attribute [rw] task_outcome_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp that indicates when the Task's outcome was set by the
+          #     provider.
+          # @!attribute [rw] planned_location
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::LocationInfo]
+          #     Immutable. The location where the Task will be completed.
+          # @!attribute [rw] target_time_window
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TimeWindow]
+          #     The time window during which the task should be completed.
+          # @!attribute [rw] attributes
+          #   @return [::Array<::Google::Maps::FleetEngine::Delivery::V1::TaskAttribute>]
+          #     The custom attributes set on the task.
+          class TaskTrackingInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end