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

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

@@ -0,0 +1,281 @@
+# 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 Task in the Delivery API represents a single action to track. In general,
+          # there is a distinction between shipment-related Tasks and break Tasks. A
+          # shipment can have multiple Tasks associated with it. For example, there could
+          # be one Task for the pickup, and one for the drop-off or transfer. Also,
+          # different Tasks for a given shipment can be handled by different vehicles.
+          # For example, one vehicle could handle the pickup, driving the shipment to the
+          # hub, while another vehicle drives the same shipment from the hub to the
+          # drop-off location.
+          #
+          # Note: gRPC and REST APIs use different field naming conventions. For example,
+          # the `Task.journey_sharing_info` field in the gRPC API and the
+          # `Task.journeySharingInfo` field in the REST API refer to the same
+          # field.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Must be in the format `providers/{provider}/tasks/{task}`.
+          # @!attribute [rw] type
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::Type]
+          #     Required. Immutable. Defines the type of the Task. For example, a break or
+          #     shipment.
+          # @!attribute [rw] state
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::State]
+          #     Required. The current execution state of the Task.
+          # @!attribute [rw] task_outcome
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::TaskOutcome]
+          #     The outcome of the 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] task_outcome_location
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::LocationInfo]
+          #     The location where the `Task`'s outcome was set. This value is updated as
+          #     part of `UpdateTask`. If this value isn't explicitly updated by the
+          #     provider, then Fleet Engine populates it by default with the last known
+          #     vehicle location (the *raw* location).
+          # @!attribute [rw] task_outcome_location_source
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::TaskOutcomeLocationSource]
+          #     Indicates where the value of the `task_outcome_location` came from.
+          # @!attribute [rw] tracking_id
+          #   @return [::String]
+          #     Immutable. This field facilitates the storing of an ID so you can avoid
+          #     using a complicated mapping. You cannot set `tracking_id` for Tasks of type
+          #     `UNAVAILABLE` and `SCHEDULED_STOP`. These 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] delivery_vehicle_id
+          #   @return [::String]
+          #     Output only. The ID of the vehicle that is executing this Task. Delivery
+          #     Vehicle 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 [rw] planned_location
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::LocationInfo]
+          #     Immutable. The location where the Task will be completed.
+          #     Optional for `UNAVAILABLE` Tasks, but required for all other Tasks.
+          # @!attribute [rw] task_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Required. Immutable. The time needed to execute a Task at this location.
+          # @!attribute [rw] target_time_window
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TimeWindow]
+          #     The time window during which the task should be completed.
+          # @!attribute [r] journey_sharing_info
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::Task::JourneySharingInfo]
+          #     Output only. Journey sharing-specific fields. Not populated when state is
+          #     `CLOSED`.
+          # @!attribute [rw] task_tracking_view_config
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig]
+          #     The configuration for task tracking that specifies which data elements are
+          #     visible to the end users under what circumstances.
+          # @!attribute [rw] attributes
+          #   @return [::Array<::Google::Maps::FleetEngine::Delivery::V1::TaskAttribute>]
+          #     A list of custom Task attributes. Each attribute must have a unique key.
+          class Task
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Journey sharing specific fields.
+            # @!attribute [rw] remaining_vehicle_journey_segments
+            #   @return [::Array<::Google::Maps::FleetEngine::Delivery::V1::VehicleJourneySegment>]
+            #     Tracking information for the stops that the assigned vehicle will make
+            #     before it completes this Task. Note that this list can contain stops
+            #     from other tasks.
+            #
+            #     The first segment,
+            #     `Task.journey_sharing_info.remaining_vehicle_journey_segments[0]` (gRPC)
+            #     or `Task.journeySharingInfo.remainingVehicleJourneySegments[0]` (REST),
+            #     contains route information from the driver's last known location to the
+            #     upcoming `VehicleStop`. Current route information usually comes from the
+            #     driver app, except for some cases noted in the documentation for
+            #     {::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle#current_route_segment DeliveryVehicle.current_route_segment}.
+            #     The other segments in
+            #     `Task.journey_sharing_info.remaining_vehicle_journey_segments` (gRPC) or
+            #     `Task.journeySharingInfo.remainingVehicleJourneySegments` (REST) are
+            #     populated by Fleet Engine. They provide route information between the
+            #     remaining `VehicleStops`.
+            # @!attribute [rw] last_location
+            #   @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocation]
+            #     Indicates the vehicle's last reported location of the assigned vehicle.
+            # @!attribute [rw] last_location_snappable
+            #   @return [::Boolean]
+            #     Indicates whether the vehicle's lastLocation can be snapped to
+            #     the `current_route_segment`. This value is False if either
+            #     `last_location` or `current_route_segment` don't exist. This value is
+            #     computed by Fleet Engine. Updates from clients are ignored.
+            class JourneySharingInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The type of Task.
+            module Type
+              # Default, the Task type is unknown.
+              TYPE_UNSPECIFIED = 0
+
+              # A pickup Task is the action taken for picking up a shipment from a
+              # customer. Depot or feeder vehicle pickups should use the `SCHEDULED_STOP`
+              # type.
+              PICKUP = 1
+
+              # A delivery Task is the action taken for delivering a shipment to an end
+              # customer. Depot or feeder vehicle dropoffs should use the
+              # `SCHEDULED_STOP` type.
+              DELIVERY = 2
+
+              # A scheduled stop Task is used for planning purposes. For example, it
+              # could represent picking up or dropping off shipments from feeder vehicles
+              # or depots. It shouldn't be used for any shipments that are picked up or
+              # dropped off from an end customer.
+              SCHEDULED_STOP = 3
+
+              # A Task that means the Vehicle is not available for service. For example,
+              # this can happen when the driver takes a break, or when the vehicle
+              # is being refueled.
+              UNAVAILABLE = 4
+            end
+
+            # The state of a Task. This indicates the Tasks's progress.
+            module State
+              # Default. Used for an unspecified or unrecognized Task state.
+              STATE_UNSPECIFIED = 0
+
+              # Either the Task has not yet been assigned to a delivery vehicle, or the
+              # delivery vehicle has not yet passed the `Task`'s assigned vehicle stop.
+              OPEN = 1
+
+              # When the vehicle passes the vehicle stop for this Task.
+              CLOSED = 2
+            end
+
+            # The outcome of attempting to execute a Task. When `TaskState` is closed,
+            # `TaskOutcome` indicates whether it was completed successfully.
+            module TaskOutcome
+              # The Task outcome before its value is set.
+              TASK_OUTCOME_UNSPECIFIED = 0
+
+              # The Task completed successfully.
+              SUCCEEDED = 1
+
+              # Either the Task couldn't be completed, or it was cancelled.
+              FAILED = 2
+            end
+
+            # The identity of the source that populated the `task_outcome_location`.
+            module TaskOutcomeLocationSource
+              # The task outcome before it is set.
+              TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED = 0
+
+              # The provider-specified the `task_outcome_location`.
+              PROVIDER = 2
+
+              # The provider didn't specify the `task_outcome_location`, so Fleet Engine
+              # used the last known vehicle location.
+              LAST_VEHICLE_LOCATION = 3
+            end
+          end
+
+          # The configuration message that defines when a data element of a Task should
+          # be visible to the end users.
+          # @!attribute [rw] route_polyline_points_visibility
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig::VisibilityOption]
+          #     The field that specifies when route polyline points can be visible. If this
+          #     field is not specified, the project level default visibility configuration
+          #     for this data will be used.
+          # @!attribute [rw] estimated_arrival_time_visibility
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig::VisibilityOption]
+          #     The field that specifies when estimated arrival time can be visible. If
+          #     this field is not specified, the project level default visibility
+          #     configuration for this data will be used.
+          # @!attribute [rw] estimated_task_completion_time_visibility
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig::VisibilityOption]
+          #     The field that specifies when estimated task completion time can be
+          #     visible. If this field is not specified, the project level default
+          #     visibility configuration for this data will be used.
+          # @!attribute [rw] remaining_driving_distance_visibility
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig::VisibilityOption]
+          #     The field that specifies when remaining driving distance can be visible. If
+          #     this field is not specified, the project level default visibility
+          #     configuration for this data will be used.
+          # @!attribute [rw] remaining_stop_count_visibility
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig::VisibilityOption]
+          #     The field that specifies when remaining stop count can be visible. If this
+          #     field is not specified, the project level default visibility configuration
+          #     for this data will be used.
+          # @!attribute [rw] vehicle_location_visibility
+          #   @return [::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingViewConfig::VisibilityOption]
+          #     The field that specifies when vehicle location can be visible. If this
+          #     field is not specified, the project level default visibility configuration
+          #     for this data will be used.
+          class TaskTrackingViewConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The option message that defines when a data element should be visible to
+            # the end users.
+            # @!attribute [rw] remaining_stop_count_threshold
+            #   @return [::Integer]
+            #     This data element is visible to the end users if the remaining stop
+            #     count <= remaining_stop_count_threshold.
+            # @!attribute [rw] duration_until_estimated_arrival_time_threshold
+            #   @return [::Google::Protobuf::Duration]
+            #     This data element is visible to the end users if the ETA to the stop
+            #     <= duration_until_estimated_arrival_time_threshold.
+            # @!attribute [rw] remaining_driving_distance_meters_threshold
+            #   @return [::Integer]
+            #     This data element is visible to the end users if the remaining
+            #     driving distance in meters <=
+            #     remaining_driving_distance_meters_threshold.
+            # @!attribute [rw] always
+            #   @return [::Boolean]
+            #     If set to true, this data element is always visible to the end users
+            #     with no thresholds. This field cannot be set to false.
+            # @!attribute [rw] never
+            #   @return [::Boolean]
+            #     If set to true, this data element is always hidden from the end users
+            #     with no thresholds. This field cannot be set to false.
+            class VisibilityOption
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# 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 Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end