google-maps-routeoptimization 0.1.0__py3-none-any.whl

google/maps/routeoptimization_v1/services/route_optimization/transports/rest.py

@@ -0,0 +1,631 @@
+# -*- coding: utf-8 -*-
+# 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
+#
+#     http://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.
+#
+
+import dataclasses
+import json  # type: ignore
+import re
+from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union
+import warnings
+
+from google.api_core import (
+    gapic_v1,
+    operations_v1,
+    path_template,
+    rest_helpers,
+    rest_streaming,
+)
+from google.api_core import exceptions as core_exceptions
+from google.api_core import retry as retries
+from google.auth import credentials as ga_credentials  # type: ignore
+from google.auth.transport.grpc import SslCredentials  # type: ignore
+from google.auth.transport.requests import AuthorizedSession  # type: ignore
+from google.protobuf import json_format
+import grpc  # type: ignore
+from requests import __version__ as requests_version
+
+try:
+    OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
+except AttributeError:  # pragma: NO COVER
+    OptionalRetry = Union[retries.Retry, object, None]  # type: ignore
+
+
+from google.longrunning import operations_pb2  # type: ignore
+
+from google.maps.routeoptimization_v1.types import route_optimization_service
+
+from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
+from .base import RouteOptimizationTransport
+
+DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+    gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version,
+    grpc_version=None,
+    rest_version=requests_version,
+)
+
+
+class RouteOptimizationRestInterceptor:
+    """Interceptor for RouteOptimization.
+
+    Interceptors are used to manipulate requests, request metadata, and responses
+    in arbitrary ways.
+    Example use cases include:
+    * Logging
+    * Verifying requests according to service or custom semantics
+    * Stripping extraneous information from responses
+
+    These use cases and more can be enabled by injecting an
+    instance of a custom subclass when constructing the RouteOptimizationRestTransport.
+
+    .. code-block:: python
+        class MyCustomRouteOptimizationInterceptor(RouteOptimizationRestInterceptor):
+            def pre_batch_optimize_tours(self, request, metadata):
+                logging.log(f"Received request: {request}")
+                return request, metadata
+
+            def post_batch_optimize_tours(self, response):
+                logging.log(f"Received response: {response}")
+                return response
+
+            def pre_optimize_tours(self, request, metadata):
+                logging.log(f"Received request: {request}")
+                return request, metadata
+
+            def post_optimize_tours(self, response):
+                logging.log(f"Received response: {response}")
+                return response
+
+        transport = RouteOptimizationRestTransport(interceptor=MyCustomRouteOptimizationInterceptor())
+        client = RouteOptimizationClient(transport=transport)
+
+
+    """
+
+    def pre_batch_optimize_tours(
+        self,
+        request: route_optimization_service.BatchOptimizeToursRequest,
+        metadata: Sequence[Tuple[str, str]],
+    ) -> Tuple[
+        route_optimization_service.BatchOptimizeToursRequest, Sequence[Tuple[str, str]]
+    ]:
+        """Pre-rpc interceptor for batch_optimize_tours
+
+        Override in a subclass to manipulate the request or metadata
+        before they are sent to the RouteOptimization server.
+        """
+        return request, metadata
+
+    def post_batch_optimize_tours(
+        self, response: operations_pb2.Operation
+    ) -> operations_pb2.Operation:
+        """Post-rpc interceptor for batch_optimize_tours
+
+        Override in a subclass to manipulate the response
+        after it is returned by the RouteOptimization server but before
+        it is returned to user code.
+        """
+        return response
+
+    def pre_optimize_tours(
+        self,
+        request: route_optimization_service.OptimizeToursRequest,
+        metadata: Sequence[Tuple[str, str]],
+    ) -> Tuple[
+        route_optimization_service.OptimizeToursRequest, Sequence[Tuple[str, str]]
+    ]:
+        """Pre-rpc interceptor for optimize_tours
+
+        Override in a subclass to manipulate the request or metadata
+        before they are sent to the RouteOptimization server.
+        """
+        return request, metadata
+
+    def post_optimize_tours(
+        self, response: route_optimization_service.OptimizeToursResponse
+    ) -> route_optimization_service.OptimizeToursResponse:
+        """Post-rpc interceptor for optimize_tours
+
+        Override in a subclass to manipulate the response
+        after it is returned by the RouteOptimization server but before
+        it is returned to user code.
+        """
+        return response
+
+    def pre_get_operation(
+        self,
+        request: operations_pb2.GetOperationRequest,
+        metadata: Sequence[Tuple[str, str]],
+    ) -> Tuple[operations_pb2.GetOperationRequest, Sequence[Tuple[str, str]]]:
+        """Pre-rpc interceptor for get_operation
+
+        Override in a subclass to manipulate the request or metadata
+        before they are sent to the RouteOptimization server.
+        """
+        return request, metadata
+
+    def post_get_operation(
+        self, response: operations_pb2.Operation
+    ) -> operations_pb2.Operation:
+        """Post-rpc interceptor for get_operation
+
+        Override in a subclass to manipulate the response
+        after it is returned by the RouteOptimization server but before
+        it is returned to user code.
+        """
+        return response
+
+
+@dataclasses.dataclass
+class RouteOptimizationRestStub:
+    _session: AuthorizedSession
+    _host: str
+    _interceptor: RouteOptimizationRestInterceptor
+
+
+class RouteOptimizationRestTransport(RouteOptimizationTransport):
+    """REST backend transport for RouteOptimization.
+
+    A service for optimizing vehicle tours.
+
+    Validity of certain types of fields:
+
+    -  ``google.protobuf.Timestamp``
+
+       -  Times are in Unix time: seconds since
+          1970-01-01T00:00:00+00:00.
+       -  seconds must be in [0, 253402300799], i.e. in
+          [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
+       -  nanos must be unset or set to 0.
+
+    -  ``google.protobuf.Duration``
+
+       -  seconds must be in [0, 253402300799], i.e. in
+          [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
+       -  nanos must be unset or set to 0.
+
+    -  ``google.type.LatLng``
+
+       -  latitude must be in [-90.0, 90.0].
+       -  longitude must be in [-180.0, 180.0].
+       -  at least one of latitude and longitude must be non-zero.
+
+    This class defines the same methods as the primary client, so the
+    primary client can load the underlying transport implementation
+    and call it.
+
+    It sends JSON representations of protocol buffers over HTTP/1.1
+
+    """
+
+    def __init__(
+        self,
+        *,
+        host: str = "routeoptimization.googleapis.com",
+        credentials: Optional[ga_credentials.Credentials] = None,
+        credentials_file: Optional[str] = None,
+        scopes: Optional[Sequence[str]] = None,
+        client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None,
+        quota_project_id: Optional[str] = None,
+        client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+        always_use_jwt_access: Optional[bool] = False,
+        url_scheme: str = "https",
+        interceptor: Optional[RouteOptimizationRestInterceptor] = None,
+        api_audience: Optional[str] = None,
+    ) -> None:
+        """Instantiate the transport.
+
+        Args:
+            host (Optional[str]):
+                 The hostname to connect to (default: 'routeoptimization.googleapis.com').
+            credentials (Optional[google.auth.credentials.Credentials]): The
+                authorization credentials to attach to requests. These
+                credentials identify the application to the service; if none
+                are specified, the client will attempt to ascertain the
+                credentials from the environment.
+
+            credentials_file (Optional[str]): A file with credentials that can
+                be loaded with :func:`google.auth.load_credentials_from_file`.
+                This argument is ignored if ``channel`` is provided.
+            scopes (Optional(Sequence[str])): A list of scopes. This argument is
+                ignored if ``channel`` is provided.
+            client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client
+                certificate to configure mutual TLS HTTP channel. It is ignored
+                if ``channel`` is provided.
+            quota_project_id (Optional[str]): An optional project to use for billing
+                and quota.
+            client_info (google.api_core.gapic_v1.client_info.ClientInfo):
+                The client info used to send a user-agent string along with
+                API requests. If ``None``, then default info will be used.
+                Generally, you only need to set this if you are developing
+                your own client library.
+            always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+                be used for service account credentials.
+            url_scheme: the protocol scheme for the API endpoint.  Normally
+                "https", but for testing or local servers,
+                "http" can be specified.
+        """
+        # Run the base constructor
+        # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc.
+        # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the
+        # credentials object
+        maybe_url_match = re.match("^(?P<scheme>http(?:s)?://)?(?P<host>.*)$", host)
+        if maybe_url_match is None:
+            raise ValueError(
+                f"Unexpected hostname structure: {host}"
+            )  # pragma: NO COVER
+
+        url_match_items = maybe_url_match.groupdict()
+
+        host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host
+
+        super().__init__(
+            host=host,
+            credentials=credentials,
+            client_info=client_info,
+            always_use_jwt_access=always_use_jwt_access,
+            api_audience=api_audience,
+        )
+        self._session = AuthorizedSession(
+            self._credentials, default_host=self.DEFAULT_HOST
+        )
+        self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None
+        if client_cert_source_for_mtls:
+            self._session.configure_mtls_channel(client_cert_source_for_mtls)
+        self._interceptor = interceptor or RouteOptimizationRestInterceptor()
+        self._prep_wrapped_messages(client_info)
+
+    @property
+    def operations_client(self) -> operations_v1.AbstractOperationsClient:
+        """Create the client designed to process long-running operations.
+
+        This property caches on the instance; repeated calls return the same
+        client.
+        """
+        # Only create a new client if we do not already have one.
+        if self._operations_client is None:
+            http_options: Dict[str, List[Dict[str, str]]] = {
+                "google.longrunning.Operations.GetOperation": [
+                    {
+                        "method": "get",
+                        "uri": "/v1/{name=projects/*/locations/*/operations/*}",
+                    },
+                ],
+            }
+
+            rest_transport = operations_v1.OperationsRestTransport(
+                host=self._host,
+                # use the credentials which are saved
+                credentials=self._credentials,
+                scopes=self._scopes,
+                http_options=http_options,
+                path_prefix="v1",
+            )
+
+            self._operations_client = operations_v1.AbstractOperationsClient(
+                transport=rest_transport
+            )
+
+        # Return the client from cache.
+        return self._operations_client
+
+    class _BatchOptimizeTours(RouteOptimizationRestStub):
+        def __hash__(self):
+            return hash("BatchOptimizeTours")
+
+        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {}
+
+        @classmethod
+        def _get_unset_required_fields(cls, message_dict):
+            return {
+                k: v
+                for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items()
+                if k not in message_dict
+            }
+
+        def __call__(
+            self,
+            request: route_optimization_service.BatchOptimizeToursRequest,
+            *,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Optional[float] = None,
+            metadata: Sequence[Tuple[str, str]] = (),
+        ) -> operations_pb2.Operation:
+            r"""Call the batch optimize tours method over HTTP.
+
+            Args:
+                request (~.route_optimization_service.BatchOptimizeToursRequest):
+                    The request object. Request to batch optimize tours as an asynchronous
+                operation. Each input file should contain one
+                ``OptimizeToursRequest``, and each output file will
+                contain one ``OptimizeToursResponse``. The request
+                contains information to read/write and parse the files.
+                All the input and output files should be under the same
+                project.
+                retry (google.api_core.retry.Retry): Designation of what errors, if any,
+                    should be retried.
+                timeout (float): The timeout for this request.
+                metadata (Sequence[Tuple[str, str]]): Strings which should be
+                    sent along with the request as metadata.
+
+            Returns:
+                ~.operations_pb2.Operation:
+                    This resource represents a
+                long-running operation that is the
+                result of a network API call.
+
+            """
+
+            http_options: List[Dict[str, str]] = [
+                {
+                    "method": "post",
+                    "uri": "/v1/{parent=projects/*/locations/*}:batchOptimizeTours",
+                    "body": "*",
+                },
+                {
+                    "method": "post",
+                    "uri": "/v1/{parent=projects/*}:batchOptimizeTours",
+                    "body": "*",
+                },
+            ]
+            request, metadata = self._interceptor.pre_batch_optimize_tours(
+                request, metadata
+            )
+            pb_request = route_optimization_service.BatchOptimizeToursRequest.pb(
+                request
+            )
+            transcoded_request = path_template.transcode(http_options, pb_request)
+
+            # Jsonify the request body
+
+            body = json_format.MessageToJson(
+                transcoded_request["body"], use_integers_for_enums=True
+            )
+            uri = transcoded_request["uri"]
+            method = transcoded_request["method"]
+
+            # Jsonify the query params
+            query_params = json.loads(
+                json_format.MessageToJson(
+                    transcoded_request["query_params"],
+                    use_integers_for_enums=True,
+                )
+            )
+            query_params.update(self._get_unset_required_fields(query_params))
+
+            query_params["$alt"] = "json;enum-encoding=int"
+
+            # Send the request
+            headers = dict(metadata)
+            headers["Content-Type"] = "application/json"
+            response = getattr(self._session, method)(
+                "{host}{uri}".format(host=self._host, uri=uri),
+                timeout=timeout,
+                headers=headers,
+                params=rest_helpers.flatten_query_params(query_params, strict=True),
+                data=body,
+            )
+
+            # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception
+            # subclass.
+            if response.status_code >= 400:
+                raise core_exceptions.from_http_response(response)
+
+            # Return the response
+            resp = operations_pb2.Operation()
+            json_format.Parse(response.content, resp, ignore_unknown_fields=True)
+            resp = self._interceptor.post_batch_optimize_tours(resp)
+            return resp
+
+    class _OptimizeTours(RouteOptimizationRestStub):
+        def __hash__(self):
+            return hash("OptimizeTours")
+
+        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {}
+
+        @classmethod
+        def _get_unset_required_fields(cls, message_dict):
+            return {
+                k: v
+                for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items()
+                if k not in message_dict
+            }
+
+        def __call__(
+            self,
+            request: route_optimization_service.OptimizeToursRequest,
+            *,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Optional[float] = None,
+            metadata: Sequence[Tuple[str, str]] = (),
+        ) -> route_optimization_service.OptimizeToursResponse:
+            r"""Call the optimize tours method over HTTP.
+
+            Args:
+                request (~.route_optimization_service.OptimizeToursRequest):
+                    The request object. Request to be given to a tour
+                optimization solver which defines the
+                shipment model to solve as well as
+                optimization parameters.
+                retry (google.api_core.retry.Retry): Designation of what errors, if any,
+                    should be retried.
+                timeout (float): The timeout for this request.
+                metadata (Sequence[Tuple[str, str]]): Strings which should be
+                    sent along with the request as metadata.
+
+            Returns:
+                ~.route_optimization_service.OptimizeToursResponse:
+                    Response after solving a tour
+                optimization problem containing the
+                routes followed by each vehicle, the
+                shipments which have been skipped and
+                the overall cost of the solution.
+
+            """
+
+            http_options: List[Dict[str, str]] = [
+                {
+                    "method": "post",
+                    "uri": "/v1/{parent=projects/*/locations/*}:optimizeTours",
+                    "body": "*",
+                },
+                {
+                    "method": "post",
+                    "uri": "/v1/{parent=projects/*}:optimizeTours",
+                    "body": "*",
+                },
+            ]
+            request, metadata = self._interceptor.pre_optimize_tours(request, metadata)
+            pb_request = route_optimization_service.OptimizeToursRequest.pb(request)
+            transcoded_request = path_template.transcode(http_options, pb_request)
+
+            # Jsonify the request body
+
+            body = json_format.MessageToJson(
+                transcoded_request["body"], use_integers_for_enums=True
+            )
+            uri = transcoded_request["uri"]
+            method = transcoded_request["method"]
+
+            # Jsonify the query params
+            query_params = json.loads(
+                json_format.MessageToJson(
+                    transcoded_request["query_params"],
+                    use_integers_for_enums=True,
+                )
+            )
+            query_params.update(self._get_unset_required_fields(query_params))
+
+            query_params["$alt"] = "json;enum-encoding=int"
+
+            # Send the request
+            headers = dict(metadata)
+            headers["Content-Type"] = "application/json"
+            response = getattr(self._session, method)(
+                "{host}{uri}".format(host=self._host, uri=uri),
+                timeout=timeout,
+                headers=headers,
+                params=rest_helpers.flatten_query_params(query_params, strict=True),
+                data=body,
+            )
+
+            # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception
+            # subclass.
+            if response.status_code >= 400:
+                raise core_exceptions.from_http_response(response)
+
+            # Return the response
+            resp = route_optimization_service.OptimizeToursResponse()
+            pb_resp = route_optimization_service.OptimizeToursResponse.pb(resp)
+
+            json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
+            resp = self._interceptor.post_optimize_tours(resp)
+            return resp
+
+    @property
+    def batch_optimize_tours(
+        self,
+    ) -> Callable[
+        [route_optimization_service.BatchOptimizeToursRequest], operations_pb2.Operation
+    ]:
+        # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here.
+        # In C++ this would require a dynamic_cast
+        return self._BatchOptimizeTours(self._session, self._host, self._interceptor)  # type: ignore
+
+    @property
+    def optimize_tours(
+        self,
+    ) -> Callable[
+        [route_optimization_service.OptimizeToursRequest],
+        route_optimization_service.OptimizeToursResponse,
+    ]:
+        # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here.
+        # In C++ this would require a dynamic_cast
+        return self._OptimizeTours(self._session, self._host, self._interceptor)  # type: ignore
+
+    @property
+    def get_operation(self):
+        return self._GetOperation(self._session, self._host, self._interceptor)  # type: ignore
+
+    class _GetOperation(RouteOptimizationRestStub):
+        def __call__(
+            self,
+            request: operations_pb2.GetOperationRequest,
+            *,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Optional[float] = None,
+            metadata: Sequence[Tuple[str, str]] = (),
+        ) -> operations_pb2.Operation:
+            r"""Call the get operation method over HTTP.
+
+            Args:
+                request (operations_pb2.GetOperationRequest):
+                    The request object for GetOperation method.
+                retry (google.api_core.retry.Retry): Designation of what errors, if any,
+                    should be retried.
+                timeout (float): The timeout for this request.
+                metadata (Sequence[Tuple[str, str]]): Strings which should be
+                    sent along with the request as metadata.
+
+            Returns:
+                operations_pb2.Operation: Response from GetOperation method.
+            """
+
+            http_options: List[Dict[str, str]] = [
+                {
+                    "method": "get",
+                    "uri": "/v1/{name=projects/*/locations/*/operations/*}",
+                },
+            ]
+
+            request, metadata = self._interceptor.pre_get_operation(request, metadata)
+            request_kwargs = json_format.MessageToDict(request)
+            transcoded_request = path_template.transcode(http_options, **request_kwargs)
+
+            uri = transcoded_request["uri"]
+            method = transcoded_request["method"]
+
+            # Jsonify the query params
+            query_params = json.loads(json.dumps(transcoded_request["query_params"]))
+
+            # Send the request
+            headers = dict(metadata)
+            headers["Content-Type"] = "application/json"
+
+            response = getattr(self._session, method)(
+                "{host}{uri}".format(host=self._host, uri=uri),
+                timeout=timeout,
+                headers=headers,
+                params=rest_helpers.flatten_query_params(query_params),
+            )
+
+            # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception
+            # subclass.
+            if response.status_code >= 400:
+                raise core_exceptions.from_http_response(response)
+
+            resp = operations_pb2.Operation()
+            resp = json_format.Parse(response.content.decode("utf-8"), resp)
+            resp = self._interceptor.post_get_operation(resp)
+            return resp
+
+    @property
+    def kind(self) -> str:
+        return "rest"
+
+    def close(self):
+        self._session.close()
+
+
+__all__ = ("RouteOptimizationRestTransport",)

google/maps/routeoptimization_v1/types/__init__.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# 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
+#
+#     http://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.
+#
+from .route_optimization_service import (
+    AggregatedMetrics,
+    BatchOptimizeToursMetadata,
+    BatchOptimizeToursRequest,
+    BatchOptimizeToursResponse,
+    BreakRule,
+    DataFormat,
+    DistanceLimit,
+    GcsDestination,
+    GcsSource,
+    InjectedSolutionConstraint,
+    InputConfig,
+    Location,
+    OptimizeToursRequest,
+    OptimizeToursResponse,
+    OptimizeToursValidationError,
+    OutputConfig,
+    Shipment,
+    ShipmentModel,
+    ShipmentRoute,
+    ShipmentTypeIncompatibility,
+    ShipmentTypeRequirement,
+    SkippedShipment,
+    TimeWindow,
+    TransitionAttributes,
+    Vehicle,
+    Waypoint,
+)
+
+__all__ = (
+    "AggregatedMetrics",
+    "BatchOptimizeToursMetadata",
+    "BatchOptimizeToursRequest",
+    "BatchOptimizeToursResponse",
+    "BreakRule",
+    "DistanceLimit",
+    "GcsDestination",
+    "GcsSource",
+    "InjectedSolutionConstraint",
+    "InputConfig",
+    "Location",
+    "OptimizeToursRequest",
+    "OptimizeToursResponse",
+    "OptimizeToursValidationError",
+    "OutputConfig",
+    "Shipment",
+    "ShipmentModel",
+    "ShipmentRoute",
+    "ShipmentTypeIncompatibility",
+    "ShipmentTypeRequirement",
+    "SkippedShipment",
+    "TimeWindow",
+    "TransitionAttributes",
+    "Vehicle",
+    "Waypoint",
+    "DataFormat",
+)