google-maps-routeoptimization 0.1.2__tar.gz → 0.1.4__tar.gz

{google_maps_routeoptimization-0.1.2/google_maps_routeoptimization.egg-info → google_maps_routeoptimization-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: google-maps-routeoptimization
-Version: 0.1.2
+Version: 0.1.4
 Summary: Google Maps Routeoptimization API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
 Author: Google LLC

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization/__init__.py

@@ -41,6 +41,7 @@ from google.maps.routeoptimization_v1.types.route_optimization_service import (
     OptimizeToursResponse,
     OptimizeToursValidationError,
     OutputConfig,
+    RouteModifiers,
     Shipment,
     ShipmentModel,
     ShipmentRoute,
@@ -71,6 +72,7 @@ __all__ = (
     "OptimizeToursResponse",
     "OptimizeToursValidationError",
     "OutputConfig",
+    "RouteModifiers",
     "Shipment",
     "ShipmentModel",
     "ShipmentRoute",

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.2"  # {x-release-please-version}
+__version__ = "0.1.4"  # {x-release-please-version}

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/__init__.py

@@ -39,6 +39,7 @@ from .types.route_optimization_service import (
     OptimizeToursResponse,
     OptimizeToursValidationError,
     OutputConfig,
+    RouteModifiers,
     Shipment,
     ShipmentModel,
     ShipmentRoute,
@@ -69,6 +70,7 @@ __all__ = (
     "OptimizeToursResponse",
     "OptimizeToursValidationError",
     "OutputConfig",
+    "RouteModifiers",
     "RouteOptimizationClient",
     "Shipment",
     "ShipmentModel",

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.2"  # {x-release-please-version}
+__version__ = "0.1.4"  # {x-release-please-version}

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/services/route_optimization/async_client.py

@@ -14,7 +14,6 @@
 # limitations under the License.
 #
 from collections import OrderedDict
-import functools
 import re
 from typing import (
     Callable,
@@ -211,9 +210,7 @@ class RouteOptimizationAsyncClient:
         """
         return self._client._universe_domain
 
-    get_transport_class = functools.partial(
-        type(RouteOptimizationClient).get_transport_class, type(RouteOptimizationClient)
-    )
+    get_transport_class = RouteOptimizationClient.get_transport_class
 
     def __init__(
         self,
@@ -406,12 +403,26 @@ class RouteOptimizationAsyncClient:
 
         This method is a Long Running Operation (LRO). The inputs for
         optimization (``OptimizeToursRequest`` messages) and outputs
-        (``OptimizeToursResponse`` messages) are read/written from/to
-        Cloud Storage in user-specified format. Like the
+        (``OptimizeToursResponse`` messages) are read from and written
+        to Cloud Storage in user-specified format. Like the
         ``OptimizeTours`` method, each ``OptimizeToursRequest`` contains
         a ``ShipmentModel`` and returns an ``OptimizeToursResponse``
-        containing ``ShipmentRoute``\ s, which are a set of routes to be
-        performed by vehicles minimizing the overall cost.
+        containing ``ShipmentRoute`` fields, which are a set of routes
+        to be performed by vehicles minimizing the overall cost.
+
+        The user can poll ``operations.get`` to check the status of the
+        LRO:
+
+        If the LRO ``done`` field is false, then at least one request is
+        still being processed. Other requests may have completed
+        successfully and their results are available in Cloud Storage.
+
+        If the LRO's ``done`` field is true, then all requests have been
+        processed. Any successfully processed requests will have their
+        results available in Cloud Storage. Any requests that failed
+        will not have their results available in Cloud Storage. If the
+        LRO's ``error`` field is set, then it contains the error from
+        one of the failed requests.
 
         .. code-block:: python
 

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/services/route_optimization/client.py

@@ -669,7 +669,7 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
                 Type[RouteOptimizationTransport],
                 Callable[..., RouteOptimizationTransport],
             ] = (
-                type(self).get_transport_class(transport)
+                RouteOptimizationClient.get_transport_class(transport)
                 if isinstance(transport, str) or transport is None
                 else cast(Callable[..., RouteOptimizationTransport], transport)
             )
@@ -805,12 +805,26 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
 
         This method is a Long Running Operation (LRO). The inputs for
         optimization (``OptimizeToursRequest`` messages) and outputs
-        (``OptimizeToursResponse`` messages) are read/written from/to
-        Cloud Storage in user-specified format. Like the
+        (``OptimizeToursResponse`` messages) are read from and written
+        to Cloud Storage in user-specified format. Like the
         ``OptimizeTours`` method, each ``OptimizeToursRequest`` contains
         a ``ShipmentModel`` and returns an ``OptimizeToursResponse``
-        containing ``ShipmentRoute``\ s, which are a set of routes to be
-        performed by vehicles minimizing the overall cost.
+        containing ``ShipmentRoute`` fields, which are a set of routes
+        to be performed by vehicles minimizing the overall cost.
+
+        The user can poll ``operations.get`` to check the status of the
+        LRO:
+
+        If the LRO ``done`` field is false, then at least one request is
+        still being processed. Other requests may have completed
+        successfully and their results are available in Cloud Storage.
+
+        If the LRO's ``done`` field is true, then all requests have been
+        processed. Any successfully processed requests will have their
+        results available in Cloud Storage. Any requests that failed
+        will not have their results available in Cloud Storage. If the
+        LRO's ``error`` field is set, then it contains the error from
+        one of the failed requests.
 
         .. code-block:: python
 

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/services/route_optimization/transports/grpc.py

@@ -329,12 +329,26 @@ class RouteOptimizationGrpcTransport(RouteOptimizationTransport):
 
         This method is a Long Running Operation (LRO). The inputs for
         optimization (``OptimizeToursRequest`` messages) and outputs
-        (``OptimizeToursResponse`` messages) are read/written from/to
-        Cloud Storage in user-specified format. Like the
+        (``OptimizeToursResponse`` messages) are read from and written
+        to Cloud Storage in user-specified format. Like the
         ``OptimizeTours`` method, each ``OptimizeToursRequest`` contains
         a ``ShipmentModel`` and returns an ``OptimizeToursResponse``
-        containing ``ShipmentRoute``\ s, which are a set of routes to be
-        performed by vehicles minimizing the overall cost.
+        containing ``ShipmentRoute`` fields, which are a set of routes
+        to be performed by vehicles minimizing the overall cost.
+
+        The user can poll ``operations.get`` to check the status of the
+        LRO:
+
+        If the LRO ``done`` field is false, then at least one request is
+        still being processed. Other requests may have completed
+        successfully and their results are available in Cloud Storage.
+
+        If the LRO's ``done`` field is true, then all requests have been
+        processed. Any successfully processed requests will have their
+        results available in Cloud Storage. Any requests that failed
+        will not have their results available in Cloud Storage. If the
+        LRO's ``error`` field is set, then it contains the error from
+        one of the failed requests.
 
         Returns:
             Callable[[~.BatchOptimizeToursRequest],

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/services/route_optimization/transports/grpc_asyncio.py

@@ -336,12 +336,26 @@ class RouteOptimizationGrpcAsyncIOTransport(RouteOptimizationTransport):
 
         This method is a Long Running Operation (LRO). The inputs for
         optimization (``OptimizeToursRequest`` messages) and outputs
-        (``OptimizeToursResponse`` messages) are read/written from/to
-        Cloud Storage in user-specified format. Like the
+        (``OptimizeToursResponse`` messages) are read from and written
+        to Cloud Storage in user-specified format. Like the
         ``OptimizeTours`` method, each ``OptimizeToursRequest`` contains
         a ``ShipmentModel`` and returns an ``OptimizeToursResponse``
-        containing ``ShipmentRoute``\ s, which are a set of routes to be
-        performed by vehicles minimizing the overall cost.
+        containing ``ShipmentRoute`` fields, which are a set of routes
+        to be performed by vehicles minimizing the overall cost.
+
+        The user can poll ``operations.get`` to check the status of the
+        LRO:
+
+        If the LRO ``done`` field is false, then at least one request is
+        still being processed. Other requests may have completed
+        successfully and their results are available in Cloud Storage.
+
+        If the LRO's ``done`` field is true, then all requests have been
+        processed. Any successfully processed requests will have their
+        results available in Cloud Storage. Any requests that failed
+        will not have their results available in Cloud Storage. If the
+        LRO's ``error`` field is set, then it contains the error from
+        one of the failed requests.
 
         Returns:
             Callable[[~.BatchOptimizeToursRequest],

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/types/__init__.py

@@ -30,6 +30,7 @@ from .route_optimization_service import (
     OptimizeToursResponse,
     OptimizeToursValidationError,
     OutputConfig,
+    RouteModifiers,
     Shipment,
     ShipmentModel,
     ShipmentRoute,
@@ -58,6 +59,7 @@ __all__ = (
     "OptimizeToursResponse",
     "OptimizeToursValidationError",
     "OutputConfig",
+    "RouteModifiers",
     "Shipment",
     "ShipmentModel",
     "ShipmentRoute",

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/google/maps/routeoptimization_v1/types/route_optimization_service.py

@@ -35,6 +35,7 @@ __protobuf__ = proto.module(
         "Shipment",
         "ShipmentTypeIncompatibility",
         "ShipmentTypeRequirement",
+        "RouteModifiers",
         "Vehicle",
         "TimeWindow",
         "DistanceLimit",
@@ -337,7 +338,8 @@ class OptimizeToursRequest(proto.Message):
             If true, polylines will be populated in response
             ``ShipmentRoute``\ s.
         populate_transition_polylines (bool):
-            If true, polylines will be populated in response
+            If true, polylines and route tokens will be populated in
+            response
             [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions].
         allow_large_deadline_despite_interruption_risk (bool):
             If this is set, then the request can have a
@@ -382,7 +384,8 @@ class OptimizeToursRequest(proto.Message):
 
         Values:
             DEFAULT_SOLVE (0):
-                Solve the model.
+                Solve the model. Warnings may be issued in
+                [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors].
             VALIDATE_ONLY (1):
                 Only validates the model without solving it: populates as
                 many
@@ -531,7 +534,8 @@ class OptimizeToursResponse(proto.Message):
             detect independently. See the "MULTIPLE ERRORS" explanation
             for the
             [OptimizeToursValidationError][google.maps.routeoptimization.v1.OptimizeToursValidationError]
-            message.
+            message. Instead of errors, this will include warnings in
+            the case ``solving_mode`` is ``DEFAULT_SOLVE``.
         metrics (google.maps.routeoptimization_v1.types.OptimizeToursResponse.Metrics):
             Duration, distance and usage metrics for this
             solution.
@@ -1524,6 +1528,53 @@ class ShipmentTypeRequirement(proto.Message):
     )
 
 
+class RouteModifiers(proto.Message):
+    r"""Encapsulates a set of optional conditions to satisfy when
+    calculating vehicle routes. This is similar to ``RouteModifiers`` in
+    the Google Maps Platform Routes Preferred API; see:
+    https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers.
+
+    Attributes:
+        avoid_tolls (bool):
+            Specifies whether to avoid toll roads where
+            reasonable. Preference will be given to routes
+            not containing toll roads. Applies only to
+            motorized travel modes.
+        avoid_highways (bool):
+            Specifies whether to avoid highways where
+            reasonable. Preference will be given to routes
+            not containing highways. Applies only to
+            motorized travel modes.
+        avoid_ferries (bool):
+            Specifies whether to avoid ferries where
+            reasonable. Preference will be given to routes
+            not containing travel by ferries. Applies only
+            to motorized travel modes.
+        avoid_indoor (bool):
+            Optional. Specifies whether to avoid navigating indoors
+            where reasonable. Preference will be given to routes not
+            containing indoor navigation. Applies only to the
+            ``WALKING`` travel mode.
+    """
+
+    avoid_tolls: bool = proto.Field(
+        proto.BOOL,
+        number=2,
+    )
+    avoid_highways: bool = proto.Field(
+        proto.BOOL,
+        number=3,
+    )
+    avoid_ferries: bool = proto.Field(
+        proto.BOOL,
+        number=4,
+    )
+    avoid_indoor: bool = proto.Field(
+        proto.BOOL,
+        number=5,
+    )
+
+
 class Vehicle(proto.Message):
     r"""Models a vehicle in a shipment problem. Solving a shipment problem
     will build a route starting from ``start_location`` and ending at
@@ -1542,6 +1593,10 @@ class Vehicle(proto.Message):
             The travel mode which affects the roads usable by the
             vehicle and its speed. See also
             ``travel_duration_multiple``.
+        route_modifiers (google.maps.routeoptimization_v1.types.RouteModifiers):
+            A set of conditions to satisfy that affect
+            the way routes are calculated for the given
+            vehicle.
         start_location (google.type.latlng_pb2.LatLng):
             Geographic location where the vehicle starts before picking
             up any shipments. If not specified, the vehicle starts at
@@ -1964,6 +2019,11 @@ class Vehicle(proto.Message):
         number=1,
         enum=TravelMode,
     )
+    route_modifiers: "RouteModifiers" = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        message="RouteModifiers",
+    )
     start_location: latlng_pb2.LatLng = proto.Field(
         proto.MESSAGE,
         number=3,
@@ -2098,8 +2158,9 @@ class TimeWindow(proto.Message):
 
     ::
 
-         0 <= `start_time` <= `soft_start_time` <= `end_time` and
-         0 <= `start_time` <= `soft_end_time` <= `end_time`.
+         0 <= `start_time` <= `end_time` and
+         0 <= `start_time` <= `soft_start_time` and
+         0 <= `soft_end_time` <= `end_time`.
 
 
     .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
@@ -2203,6 +2264,18 @@ class DistanceLimit(proto.Message):
             must be nonnegative.
 
             This field is a member of `oneof`_ ``_soft_max_meters``.
+        cost_per_kilometer_below_soft_max (float):
+            Cost per kilometer incurred, increasing up to
+            ``soft_max_meters``, with formula:
+
+            ::
+
+                 min(distance_meters, soft_max_meters) / 1000.0 *
+                 cost_per_kilometer_below_soft_max.
+
+            This cost is not supported in ``route_distance_limit``.
+
+            This field is a member of `oneof`_ ``_cost_per_kilometer_below_soft_max``.
         cost_per_kilometer_above_soft_max (float):
             Cost per kilometer incurred if distance is above
             ``soft_max_meters`` limit. The additional cost is 0 if the
@@ -2229,6 +2302,11 @@ class DistanceLimit(proto.Message):
         number=2,
         optional=True,
     )
+    cost_per_kilometer_below_soft_max: float = proto.Field(
+        proto.DOUBLE,
+        number=4,
+        optional=True,
+    )
     cost_per_kilometer_above_soft_max: float = proto.Field(
         proto.DOUBLE,
         number=3,
@@ -2860,6 +2938,18 @@ class ShipmentRoute(proto.Message):
                 [populate_transition_polylines]
                 [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines]
                 is set to true.
+            route_token (str):
+                Output only. An opaque token that can be passed to
+                `Navigation
+                SDK <https://developers.google.com/maps/documentation/navigation>`__
+                to reconstruct the route during navigation, and, in the
+                event of rerouting, honor the original intention when the
+                route was created. Treat this token as an opaque blob. Don't
+                compare its value across requests as its value may change
+                even if the service returns the exact same route. This field
+                is only populated if [populate_transition_polylines]
+                [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines]
+                is set to true.
             vehicle_loads (MutableMapping[str, google.maps.routeoptimization_v1.types.ShipmentRoute.VehicleLoad]):
                 Vehicle loads during this transition, for each type that
                 either appears in this vehicle's
@@ -2918,6 +3008,10 @@ class ShipmentRoute(proto.Message):
             number=9,
             message="ShipmentRoute.EncodedPolyline",
         )
+        route_token: str = proto.Field(
+            proto.STRING,
+            number=12,
+        )
         vehicle_loads: MutableMapping[
             str, "ShipmentRoute.VehicleLoad"
         ] = proto.MapField(
@@ -3056,7 +3150,8 @@ class SkippedShipment(proto.Message):
             if specified in the ``Shipment``.
         reasons (MutableSequence[google.maps.routeoptimization_v1.types.SkippedShipment.Reason]):
             A list of reasons that explain why the shipment was skipped.
-            See comment above ``Reason``.
+            See comment above ``Reason``. If we are unable to understand
+            why a shipment was skipped, reasons will not be set.
     """
 
     class Reason(proto.Message):
@@ -3115,9 +3210,7 @@ class SkippedShipment(proto.Message):
 
             Values:
                 CODE_UNSPECIFIED (0):
-                    This should never be used. If we are unable
-                    to understand why a shipment was skipped, we
-                    simply return an empty set of reasons.
+                    This should never be used.
                 NO_VEHICLE (1):
                     There is no vehicle in the model making all
                     shipments infeasible.
@@ -3420,8 +3513,8 @@ class InjectedSolutionConstraint(proto.Message):
                         or before them.
                     RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD (2):
                         Same as ``RELAX_VISIT_TIMES_AFTER_THRESHOLD``, but the visit
-                        sequence is also relaxed: visits remain simply bound to
-                        their vehicle.
+                        sequence is also relaxed: visits can only be performed by
+                        this vehicle, but can potentially become unperformed.
                     RELAX_ALL_AFTER_THRESHOLD (3):
                         Same as ``RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD``,
                         but the vehicle is also relaxed: visits are completely free
@@ -3478,7 +3571,7 @@ class InjectedSolutionConstraint(proto.Message):
 
 
 class OptimizeToursValidationError(proto.Message):
-    r"""Describes an error encountered when validating an
+    r"""Describes an error or warning encountered when validating an
     ``OptimizeToursRequest``.
 
     Attributes:
@@ -3486,7 +3579,8 @@ class OptimizeToursValidationError(proto.Message):
             A validation error is defined by the pair (``code``,
             ``display_name``) which are always present.
 
-            Other fields (below) provide more context about the error.
+            The fields following this section provide more context about
+            the error.
 
             *MULTIPLE ERRORS*: When there are multiple errors, the
             validation process tries to output several of them. Much
@@ -3494,338 +3588,14 @@ class OptimizeToursValidationError(proto.Message):
             validation errors will be "fatal", meaning that they stop
             the entire validation process. This is the case for
             ``display_name="UNSPECIFIED"`` errors, among others. Some
-            may cause the validation process to skip other errors.
+            errors may cause the validation process to skip other
+            errors.
 
             *STABILITY*: ``code`` and ``display_name`` should be very
             stable. But new codes and display names may appear over
             time, which may cause a given (invalid) request to yield a
             different (``code``, ``display_name``) pair because the new
-            error hid the old one (see "MULTIPLE ERRORS").
-
-            *REFERENCE*: A list of all (code, name) pairs:
-
-            -  UNSPECIFIED = 0;
-
-            -  VALIDATION_TIMEOUT_ERROR = 10; Validation couldn't be
-               completed within the deadline.
-
-            -  REQUEST_OPTIONS_ERROR = 12;
-
-               -  REQUEST_OPTIONS_INVALID_SOLVING_MODE = 1201;
-               -  REQUEST_OPTIONS_INVALID_MAX_VALIDATION_ERRORS = 1203;
-               -  REQUEST_OPTIONS_INVALID_GEODESIC_METERS_PER_SECOND =
-                  1204;
-               -  REQUEST_OPTIONS_GEODESIC_METERS_PER_SECOND_TOO_SMALL =
-                  1205;
-               -  REQUEST_OPTIONS_MISSING_GEODESIC_METERS_PER_SECOND =
-                  1206;
-               -  REQUEST_OPTIONS_POPULATE_PATHFINDER_TRIPS_AND_GEODESIC_DISTANCE
-                  = 1207;
-               -  REQUEST_OPTIONS_COST_MODEL_OPTIONS_AND_GEODESIC_DISTANCE
-                  = 1208;
-               -  REQUEST_OPTIONS_TRAVEL_MODE_INCOMPATIBLE_WITH_TRAFFIC
-                  = 1211;
-               -  REQUEST_OPTIONS_MULTIPLE_TRAFFIC_FLAVORS = 1212;
-               -  REQUEST_OPTIONS_INVALID_TRAFFIC_FLAVOR = 1213;
-               -  REQUEST_OPTIONS_TRAFFIC_ENABLED_WITHOUT_GLOBAL_START_TIME
-                  = 1214;
-               -  REQUEST_OPTIONS_TRAFFIC_ENABLED_WITH_PRECEDENCES =
-                  1215;
-               -  REQUEST_OPTIONS_TRAFFIC_PREFILL_MODE_INVALID = 1216;
-               -  REQUEST_OPTIONS_TRAFFIC_PREFILL_ENABLED_WITHOUT_TRAFFIC
-                  = 1217;
-
-            -  INJECTED_SOLUTION_ERROR = 20;
-
-               -  INJECTED_SOLUTION_MISSING_LABEL = 2000;
-               -  INJECTED_SOLUTION_DUPLICATE_LABEL = 2001;
-               -  INJECTED_SOLUTION_AMBIGUOUS_INDEX = 2002;
-               -  INJECTED_SOLUTION_INFEASIBLE_AFTER_GETTING_TRAVEL_TIMES
-                  = 2003;
-               -  INJECTED_SOLUTION_TRANSITION_INCONSISTENT_WITH_ACTUAL_TRAVEL
-                  = 2004;
-               -  INJECTED_SOLUTION_CONCURRENT_SOLUTION_TYPES = 2005;
-               -  INJECTED_SOLUTION_MORE_THAN_ONE_PER_TYPE = 2006;
-               -  INJECTED_SOLUTION_REFRESH_WITHOUT_POPULATE = 2008;
-               -  INJECTED_SOLUTION_CONSTRAINED_ROUTE_PORTION_INFEASIBLE
-                  = 2010;
-
-            -  SHIPMENT_MODEL_ERROR = 22;
-
-               -  SHIPMENT_MODEL_TOO_LARGE = 2200;
-               -  SHIPMENT_MODEL_TOO_MANY_CAPACITY_TYPES = 2201;
-               -  SHIPMENT_MODEL_GLOBAL_START_TIME_NEGATIVE_OR_NAN =
-                  2202;
-               -  SHIPMENT_MODEL_GLOBAL_END_TIME_TOO_LARGE_OR_NAN =
-                  2203;
-               -  SHIPMENT_MODEL_GLOBAL_START_TIME_AFTER_GLOBAL_END_TIME
-                  = 2204;
-               -  SHIPMENT_MODEL_GLOBAL_DURATION_TOO_LONG = 2205;
-               -  SHIPMENT_MODEL_MAX_ACTIVE_VEHICLES_NOT_POSITIVE =
-                  2206;
-               -  SHIPMENT_MODEL_DURATION_MATRIX_TOO_LARGE = 2207;
-
-            -  INDEX_ERROR = 24;
-
-            -  TAG_ERROR = 26;
-
-            -  TIME_WINDOW_ERROR = 28;
-
-               -  TIME_WINDOW_INVALID_START_TIME = 2800;
-               -  TIME_WINDOW_INVALID_END_TIME = 2801;
-               -  TIME_WINDOW_INVALID_SOFT_START_TIME = 2802;
-               -  TIME_WINDOW_INVALID_SOFT_END_TIME = 2803;
-               -  TIME_WINDOW_OUTSIDE_GLOBAL_TIME_WINDOW = 2804;
-               -  TIME_WINDOW_START_TIME_AFTER_END_TIME = 2805;
-               -  TIME_WINDOW_INVALID_COST_PER_HOUR_BEFORE_SOFT_START_TIME
-                  = 2806;
-               -  TIME_WINDOW_INVALID_COST_PER_HOUR_AFTER_SOFT_END_TIME
-                  = 2807;
-               -  TIME_WINDOW_COST_BEFORE_SOFT_START_TIME_WITHOUT_SOFT_START_TIME
-                  = 2808;
-               -  TIME_WINDOW_COST_AFTER_SOFT_END_TIME_WITHOUT_SOFT_END_TIME
-                  = 2809;
-               -  TIME_WINDOW_SOFT_START_TIME_WITHOUT_COST_BEFORE_SOFT_START_TIME
-                  = 2810;
-               -  TIME_WINDOW_SOFT_END_TIME_WITHOUT_COST_AFTER_SOFT_END_TIME
-                  = 2811;
-               -  TIME_WINDOW_OVERLAPPING_ADJACENT_OR_EARLIER_THAN_PREVIOUS
-                  = 2812;
-               -  TIME_WINDOW_START_TIME_AFTER_SOFT_START_TIME = 2813;
-               -  TIME_WINDOW_SOFT_START_TIME_AFTER_END_TIME = 2814;
-               -  TIME_WINDOW_START_TIME_AFTER_SOFT_END_TIME = 2815;
-               -  TIME_WINDOW_SOFT_END_TIME_AFTER_END_TIME = 2816;
-               -  TIME_WINDOW_COST_BEFORE_SOFT_START_TIME_SET_AND_MULTIPLE_WINDOWS
-                  = 2817;
-               -  TIME_WINDOW_COST_AFTER_SOFT_END_TIME_SET_AND_MULTIPLE_WINDOWS
-                  = 2818;
-               -  TRANSITION_ATTRIBUTES_ERROR = 30;
-               -  TRANSITION_ATTRIBUTES_INVALID_COST = 3000;
-               -  TRANSITION_ATTRIBUTES_INVALID_COST_PER_KILOMETER =
-                  3001;
-               -  TRANSITION_ATTRIBUTES_DUPLICATE_TAG_PAIR = 3002;
-               -  TRANSITION_ATTRIBUTES_DISTANCE_LIMIT_MAX_METERS_UNSUPPORTED
-                  = 3003;
-               -  TRANSITION_ATTRIBUTES_UNSPECIFIED_SOURCE_TAGS = 3004;
-               -  TRANSITION_ATTRIBUTES_CONFLICTING_SOURCE_TAGS_FIELDS =
-                  3005;
-               -  TRANSITION_ATTRIBUTES_UNSPECIFIED_DESTINATION_TAGS =
-                  3006;
-               -  TRANSITION_ATTRIBUTES_CONFLICTING_DESTINATION_TAGS_FIELDS
-                  = 3007;
-               -  TRANSITION_ATTRIBUTES_DELAY_DURATION_NEGATIVE_OR_NAN =
-                  3008;
-               -  TRANSITION_ATTRIBUTES_DELAY_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 3009;
-
-            -  AMOUNT_ERROR = 31;
-
-               -  AMOUNT_NEGATIVE_VALUE = 3100;
-
-            -  LOAD_LIMIT_ERROR = 33;
-
-               -  LOAD_LIMIT_INVALID_COST_ABOVE_SOFT_MAX = 3303;
-               -  LOAD_LIMIT_SOFT_MAX_WITHOUT_COST_ABOVE_SOFT_MAX =
-                  3304;
-               -  LOAD_LIMIT_COST_ABOVE_SOFT_MAX_WITHOUT_SOFT_MAX =
-                  3305;
-               -  LOAD_LIMIT_NEGATIVE_SOFT_MAX = 3306;
-               -  LOAD_LIMIT_MIXED_DEMAND_TYPE = 3307;
-               -  LOAD_LIMIT_MAX_LOAD_NEGATIVE_VALUE = 3308;
-               -  LOAD_LIMIT_SOFT_MAX_ABOVE_MAX = 3309;
-
-            -  INTERVAL_ERROR = 34;
-
-               -  INTERVAL_MIN_EXCEEDS_MAX = 3401;
-               -  INTERVAL_NEGATIVE_MIN = 3402;
-               -  INTERVAL_NEGATIVE_MAX = 3403;
-               -  INTERVAL_MIN_EXCEEDS_CAPACITY = 3404;
-               -  INTERVAL_MAX_EXCEEDS_CAPACITY = 3405;
-
-            -  DISTANCE_LIMIT_ERROR = 36;
-
-               -  DISTANCE_LIMIT_INVALID_COST_AFTER_SOFT_MAX = 3601;
-               -  DISTANCE_LIMIT_SOFT_MAX_WITHOUT_COST_AFTER_SOFT_MAX =
-                  3602;
-               -  DISTANCE_LIMIT_COST_AFTER_SOFT_MAX_WITHOUT_SOFT_MAX =
-                  3603;
-               -  DISTANCE_LIMIT_NEGATIVE_MAX = 3604;
-               -  DISTANCE_LIMIT_NEGATIVE_SOFT_MAX = 3605;
-               -  DISTANCE_LIMIT_SOFT_MAX_LARGER_THAN_MAX = 3606;
-
-            -  DURATION_LIMIT_ERROR = 38;
-
-               -  DURATION_LIMIT_MAX_DURATION_NEGATIVE_OR_NAN = 3800;
-               -  DURATION_LIMIT_SOFT_MAX_DURATION_NEGATIVE_OR_NAN =
-                  3801;
-               -  DURATION_LIMIT_INVALID_COST_PER_HOUR_AFTER_SOFT_MAX =
-                  3802;
-               -  DURATION_LIMIT_SOFT_MAX_WITHOUT_COST_AFTER_SOFT_MAX =
-                  3803;
-               -  DURATION_LIMIT_COST_AFTER_SOFT_MAX_WITHOUT_SOFT_MAX =
-                  3804;
-               -  DURATION_LIMIT_QUADRATIC_SOFT_MAX_DURATION_NEGATIVE_OR_NAN
-                  = 3805;
-               -  DURATION_LIMIT_INVALID_COST_AFTER_QUADRATIC_SOFT_MAX =
-                  3806;
-               -  DURATION_LIMIT_QUADRATIC_SOFT_MAX_WITHOUT_COST_PER_SQUARE_HOUR
-                  = 3807;
-               -  DURATION_LIMIT_COST_PER_SQUARE_HOUR_WITHOUT_QUADRATIC_SOFT_MAX
-                  = 3808;
-               -  DURATION_LIMIT_QUADRATIC_SOFT_MAX_WITHOUT_MAX = 3809;
-               -  DURATION_LIMIT_SOFT_MAX_LARGER_THAN_MAX = 3810;
-               -  DURATION_LIMIT_QUADRATIC_SOFT_MAX_LARGER_THAN_MAX =
-                  3811;
-               -  DURATION_LIMIT_DIFF_BETWEEN_MAX_AND_QUADRATIC_SOFT_MAX_TOO_LARGE
-                  = 3812;
-               -  DURATION_LIMIT_MAX_DURATION_EXCEEDS_GLOBAL_DURATION =
-                  3813;
-               -  DURATION_LIMIT_SOFT_MAX_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 3814;
-               -  DURATION_LIMIT_QUADRATIC_SOFT_MAX_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 3815;
-
-            -  SHIPMENT_ERROR = 40;
-
-               -  SHIPMENT_PD_LIMIT_WITHOUT_PICKUP_AND_DELIVERY = 4014;
-               -  SHIPMENT_PD_ABSOLUTE_DETOUR_LIMIT_DURATION_NEGATIVE_OR_NAN
-                  = 4000;
-               -  SHIPMENT_PD_ABSOLUTE_DETOUR_LIMIT_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 4001;
-               -  SHIPMENT_PD_RELATIVE_DETOUR_LIMIT_INVALID = 4015;
-               -  SHIPMENT_PD_DETOUR_LIMIT_AND_EXTRA_VISIT_DURATION =
-                  4016;
-               -  SHIPMENT_PD_TIME_LIMIT_DURATION_NEGATIVE_OR_NAN =
-                  4002;
-               -  SHIPMENT_PD_TIME_LIMIT_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 4003;
-               -  SHIPMENT_EMPTY_SHIPMENT_TYPE = 4004;
-               -  SHIPMENT_NO_PICKUP_NO_DELIVERY = 4005;
-               -  SHIPMENT_INVALID_PENALTY_COST = 4006;
-               -  SHIPMENT_ALLOWED_VEHICLE_INDEX_OUT_OF_BOUNDS = 4007;
-               -  SHIPMENT_DUPLICATE_ALLOWED_VEHICLE_INDEX = 4008;
-               -  SHIPMENT_INCONSISTENT_COST_FOR_VEHICLE_SIZE_WITHOUT_INDEX
-                  = 4009;
-               -  SHIPMENT_INCONSISTENT_COST_FOR_VEHICLE_SIZE_WITH_INDEX
-                  = 4010;
-               -  SHIPMENT_INVALID_COST_FOR_VEHICLE = 4011;
-               -  SHIPMENT_COST_FOR_VEHICLE_INDEX_OUT_OF_BOUNDS = 4012;
-               -  SHIPMENT_DUPLICATE_COST_FOR_VEHICLE_INDEX = 4013;
-
-            -  VEHICLE_ERROR = 42;
-
-               -  VEHICLE_EMPTY_REQUIRED_OPERATOR_TYPE = 4200;
-               -  VEHICLE_DUPLICATE_REQUIRED_OPERATOR_TYPE = 4201;
-               -  VEHICLE_NO_OPERATOR_WITH_REQUIRED_OPERATOR_TYPE =
-                  4202;
-               -  VEHICLE_EMPTY_START_TAG = 4203;
-               -  VEHICLE_DUPLICATE_START_TAG = 4204;
-               -  VEHICLE_EMPTY_END_TAG = 4205;
-               -  VEHICLE_DUPLICATE_END_TAG = 4206;
-               -  VEHICLE_EXTRA_VISIT_DURATION_NEGATIVE_OR_NAN = 4207;
-               -  VEHICLE_EXTRA_VISIT_DURATION_EXCEEDS_GLOBAL_DURATION =
-                  4208;
-               -  VEHICLE_EXTRA_VISIT_DURATION_EMPTY_KEY = 4209;
-               -  VEHICLE_FIRST_SHIPMENT_INDEX_OUT_OF_BOUNDS = 4210;
-               -  VEHICLE_FIRST_SHIPMENT_IGNORED = 4211;
-               -  VEHICLE_FIRST_SHIPMENT_NOT_BOUND = 4212;
-               -  VEHICLE_LAST_SHIPMENT_INDEX_OUT_OF_BOUNDS = 4213;
-               -  VEHICLE_LAST_SHIPMENT_IGNORED = 4214;
-               -  VEHICLE_LAST_SHIPMENT_NOT_BOUND = 4215;
-               -  VEHICLE_IGNORED_WITH_USED_IF_ROUTE_IS_EMPTY = 4216;
-               -  VEHICLE_INVALID_COST_PER_KILOMETER = 4217;
-               -  VEHICLE_INVALID_COST_PER_HOUR = 4218;
-               -  VEHICLE_INVALID_COST_PER_TRAVELED_HOUR = 4219;
-               -  VEHICLE_INVALID_FIXED_COST = 4220;
-               -  VEHICLE_INVALID_TRAVEL_DURATION_MULTIPLE = 4221;
-               -  VEHICLE_TRAVEL_DURATION_MULTIPLE_WITH_SHIPMENT_PD_DETOUR_LIMITS
-                  = 4223;
-               -  VEHICLE_MATRIX_INDEX_WITH_SHIPMENT_PD_DETOUR_LIMITS =
-                  4224;
-               -  VEHICLE_MINIMUM_DURATION_LONGER_THAN_DURATION_LIMIT =
-                  4222;
-
-            -  VISIT_REQUEST_ERROR = 44;
-
-               -  VISIT_REQUEST_EMPTY_TAG = 4400;
-               -  VISIT_REQUEST_DUPLICATE_TAG = 4401;
-               -  VISIT_REQUEST_DURATION_NEGATIVE_OR_NAN = 4404;
-               -  VISIT_REQUEST_DURATION_EXCEEDS_GLOBAL_DURATION = 4405;
-
-            -  PRECEDENCE_ERROR = 46;
-
-            -  BREAK_ERROR = 48;
-
-               -  BREAK_RULE_EMPTY = 4800;
-               -  BREAK_REQUEST_UNSPECIFIED_DURATION = 4801;
-               -  BREAK_REQUEST_UNSPECIFIED_EARLIEST_START_TIME = 4802;
-               -  BREAK_REQUEST_UNSPECIFIED_LATEST_START_TIME = 4803;
-               -  BREAK_REQUEST_DURATION_NEGATIVE_OR_NAN = 4804; = 4804;
-               -  BREAK_REQUEST_LATEST_START_TIME_BEFORE_EARLIEST_START_TIME
-                  = 4805;
-               -  BREAK_REQUEST_EARLIEST_START_TIME_BEFORE_GLOBAL_START_TIME
-                  = 4806;
-               -  BREAK_REQUEST_LATEST_END_TIME_AFTER_GLOBAL_END_TIME =
-                  4807;
-               -  BREAK_REQUEST_NON_SCHEDULABLE = 4808;
-               -  BREAK_FREQUENCY_MAX_INTER_BREAK_DURATION_NEGATIVE_OR_NAN
-                  = 4809;
-               -  BREAK_FREQUENCY_MIN_BREAK_DURATION_NEGATIVE_OR_NAN =
-                  4810;
-               -  BREAK_FREQUENCY_MIN_BREAK_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 4811;
-               -  BREAK_FREQUENCY_MAX_INTER_BREAK_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 4812;
-               -  BREAK_REQUEST_DURATION_EXCEEDS_GLOBAL_DURATION = 4813;
-               -  BREAK_FREQUENCY_MISSING_MAX_INTER_BREAK_DURATION =
-                  4814;
-               -  BREAK_FREQUENCY_MISSING_MIN_BREAK_DURATION = 4815;
-
-            -  SHIPMENT_TYPE_INCOMPATIBILITY_ERROR = 50;
-
-               -  SHIPMENT_TYPE_INCOMPATIBILITY_EMPTY_TYPE = 5001;
-               -  SHIPMENT_TYPE_INCOMPATIBILITY_LESS_THAN_TWO_TYPES =
-                  5002;
-               -  SHIPMENT_TYPE_INCOMPATIBILITY_DUPLICATE_TYPE = 5003;
-               -  SHIPMENT_TYPE_INCOMPATIBILITY_INVALID_INCOMPATIBILITY_MODE
-                  = 5004;
-               -  SHIPMENT_TYPE_INCOMPATIBILITY_TOO_MANY_INCOMPATIBILITIES
-                  = 5005;
-
-            -  SHIPMENT_TYPE_REQUIREMENT_ERROR = 52;
-
-               -  SHIPMENT_TYPE_REQUIREMENT_NO_REQUIRED_TYPE = 52001;
-               -  SHIPMENT_TYPE_REQUIREMENT_NO_DEPENDENT_TYPE = 52002;
-               -  SHIPMENT_TYPE_REQUIREMENT_INVALID_REQUIREMENT_MODE =
-                  52003;
-               -  SHIPMENT_TYPE_REQUIREMENT_TOO_MANY_REQUIREMENTS =
-                  52004;
-               -  SHIPMENT_TYPE_REQUIREMENT_EMPTY_REQUIRED_TYPE = 52005;
-               -  SHIPMENT_TYPE_REQUIREMENT_DUPLICATE_REQUIRED_TYPE =
-                  52006;
-               -  SHIPMENT_TYPE_REQUIREMENT_NO_REQUIRED_TYPE_FOUND =
-                  52007;
-               -  SHIPMENT_TYPE_REQUIREMENT_EMPTY_DEPENDENT_TYPE =
-                  52008;
-               -  SHIPMENT_TYPE_REQUIREMENT_DUPLICATE_DEPENDENT_TYPE =
-                  52009;
-               -  SHIPMENT_TYPE_REQUIREMENT_SELF_DEPENDENT_TYPE = 52010;
-               -  SHIPMENT_TYPE_REQUIREMENT_GRAPH_HAS_CYCLES = 52011;
-
-            -  VEHICLE_OPERATOR_ERROR = 54;
-
-               -  VEHICLE_OPERATOR_EMPTY_TYPE = 5400;
-               -  VEHICLE_OPERATOR_MULTIPLE_START_TIME_WINDOWS = 5401;
-               -  VEHICLE_OPERATOR_SOFT_START_TIME_WINDOW = 5402;
-               -  VEHICLE_OPERATOR_MULTIPLE_END_TIME_WINDOWS = 5403;
-               -  VEHICLE_OPERATOR_SOFT_END_TIME_WINDOW = 5404;
-
-            -  DURATION_SECONDS_MATRIX_ERROR = 56;
-
-               -  DURATION_SECONDS_MATRIX_DURATION_NEGATIVE_OR_NAN =
-                  5600;
-               -  DURATION_SECONDS_MATRIX_DURATION_EXCEEDS_GLOBAL_DURATION
-                  = 5601;
+            error hid the old one. For example, see "MULTIPLE ERRORS".
         display_name (str):
             The error display name.
         fields (MutableSequence[google.maps.routeoptimization_v1.types.OptimizeToursValidationError.FieldReference]):

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4/google_maps_routeoptimization.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: google-maps-routeoptimization
-Version: 0.1.2
+Version: 0.1.4
 Summary: Google Maps Routeoptimization API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
 Author: Google LLC

{google_maps_routeoptimization-0.1.2 → google_maps_routeoptimization-0.1.4}/tests/unit/gapic/routeoptimization_v1/test_route_optimization.py

@@ -1333,22 +1333,23 @@ async def test_optimize_tours_async_use_cached_wrapped_rpc(
         )
 
         # Replace cached wrapped function with mock
-        mock_object = mock.AsyncMock()
+        mock_rpc = mock.AsyncMock()
+        mock_rpc.return_value = mock.Mock()
         client._client._transport._wrapped_methods[
             client._client._transport.optimize_tours
-        ] = mock_object
+        ] = mock_rpc
 
         request = {}
         await client.optimize_tours(request)
 
         # Establish that the underlying gRPC stub method was called.
-        assert mock_object.call_count == 1
+        assert mock_rpc.call_count == 1
 
         await client.optimize_tours(request)
 
         # Establish that a new wrapper was not created for this call
         assert wrapper_fn.call_count == 0
-        assert mock_object.call_count == 2
+        assert mock_rpc.call_count == 2
 
 
 @pytest.mark.asyncio
@@ -1570,8 +1571,9 @@ def test_batch_optimize_tours_use_cached_wrapped_rpc():
         # Establish that the underlying gRPC stub method was called.
         assert mock_rpc.call_count == 1
 
-        # Operation methods build a cached wrapper on first rpc call
-        # subsequent calls should use the cached wrapper
+        # Operation methods call wrapper_fn to build a cached
+        # client._transport.operations_client instance on first rpc call.
+        # Subsequent calls should use the cached wrapper
         wrapper_fn.reset_mock()
 
         client.batch_optimize_tours(request)
@@ -1627,26 +1629,28 @@ async def test_batch_optimize_tours_async_use_cached_wrapped_rpc(
         )
 
         # Replace cached wrapped function with mock
-        mock_object = mock.AsyncMock()
+        mock_rpc = mock.AsyncMock()
+        mock_rpc.return_value = mock.Mock()
         client._client._transport._wrapped_methods[
             client._client._transport.batch_optimize_tours
-        ] = mock_object
+        ] = mock_rpc
 
         request = {}
         await client.batch_optimize_tours(request)
 
         # Establish that the underlying gRPC stub method was called.
-        assert mock_object.call_count == 1
+        assert mock_rpc.call_count == 1
 
-        # Operation methods build a cached wrapper on first rpc call
-        # subsequent calls should use the cached wrapper
+        # Operation methods call wrapper_fn to build a cached
+        # client._transport.operations_client instance on first rpc call.
+        # Subsequent calls should use the cached wrapper
         wrapper_fn.reset_mock()
 
         await client.batch_optimize_tours(request)
 
         # Establish that a new wrapper was not created for this call
         assert wrapper_fn.call_count == 0
-        assert mock_object.call_count == 2
+        assert mock_rpc.call_count == 2
 
 
 @pytest.mark.asyncio