As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.maps.routeoptimization_v1.services.route_optimization.async_client
# -*- 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 collections import OrderedDict
import functools
import re
from typing import (
Callable,
Dict,
Mapping,
MutableMapping,
MutableSequence,
Optional,
Sequence,
Tuple,
Type,
Union,
)
from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
from google.api_core import retry_async as retries
from google.api_core.client_options import ClientOptions
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
from google.maps.routeoptimization_v1 import gapic_version as package_version
try:
OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None]
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore
from google.api_core import operation # type: ignore
from google.api_core import operation_async # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.maps.routeoptimization_v1.types import route_optimization_service
from .client import RouteOptimizationClient
from .transports.base import DEFAULT_CLIENT_INFO, RouteOptimizationTransport
from .transports.grpc_asyncio import RouteOptimizationGrpcAsyncIOTransport
[docs]class RouteOptimizationAsyncClient:
"""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.
"""
_client: RouteOptimizationClient
# Copy defaults from the synchronous client for use here.
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
DEFAULT_ENDPOINT = RouteOptimizationClient.DEFAULT_ENDPOINT
DEFAULT_MTLS_ENDPOINT = RouteOptimizationClient.DEFAULT_MTLS_ENDPOINT
_DEFAULT_ENDPOINT_TEMPLATE = RouteOptimizationClient._DEFAULT_ENDPOINT_TEMPLATE
_DEFAULT_UNIVERSE = RouteOptimizationClient._DEFAULT_UNIVERSE
common_billing_account_path = staticmethod(
RouteOptimizationClient.common_billing_account_path
)
parse_common_billing_account_path = staticmethod(
RouteOptimizationClient.parse_common_billing_account_path
)
common_folder_path = staticmethod(RouteOptimizationClient.common_folder_path)
parse_common_folder_path = staticmethod(
RouteOptimizationClient.parse_common_folder_path
)
common_organization_path = staticmethod(
RouteOptimizationClient.common_organization_path
)
parse_common_organization_path = staticmethod(
RouteOptimizationClient.parse_common_organization_path
)
common_project_path = staticmethod(RouteOptimizationClient.common_project_path)
parse_common_project_path = staticmethod(
RouteOptimizationClient.parse_common_project_path
)
common_location_path = staticmethod(RouteOptimizationClient.common_location_path)
parse_common_location_path = staticmethod(
RouteOptimizationClient.parse_common_location_path
)
[docs] @classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
RouteOptimizationAsyncClient: The constructed client.
"""
return RouteOptimizationClient.from_service_account_info.__func__(RouteOptimizationAsyncClient, info, *args, **kwargs) # type: ignore
[docs] @classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
RouteOptimizationAsyncClient: The constructed client.
"""
return RouteOptimizationClient.from_service_account_file.__func__(RouteOptimizationAsyncClient, filename, *args, **kwargs) # type: ignore
from_service_account_json = from_service_account_file
[docs] @classmethod
def get_mtls_endpoint_and_cert_source(
cls, client_options: Optional[ClientOptions] = None
):
"""Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
client cert source is None.
(2) if `client_options.client_cert_source` is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if `client_options.api_endpoint` if provided, use the provided one.
(2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Args:
client_options (google.api_core.client_options.ClientOptions): Custom options for the
client. Only the `api_endpoint` and `client_cert_source` properties may be used
in this method.
Returns:
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
client cert source to use.
Raises:
google.auth.exceptions.MutualTLSChannelError: If any errors happen.
"""
return RouteOptimizationClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore
@property
def transport(self) -> RouteOptimizationTransport:
"""Returns the transport used by the client instance.
Returns:
RouteOptimizationTransport: The transport used by the client instance.
"""
return self._client.transport
@property
def api_endpoint(self):
"""Return the API endpoint used by the client instance.
Returns:
str: The API endpoint used by the client instance.
"""
return self._client._api_endpoint
@property
def universe_domain(self) -> str:
"""Return the universe domain used by the client instance.
Returns:
str: The universe domain used
by the client instance.
"""
return self._client._universe_domain
get_transport_class = functools.partial(
type(RouteOptimizationClient).get_transport_class, type(RouteOptimizationClient)
)
def __init__(
self,
*,
credentials: Optional[ga_credentials.Credentials] = None,
transport: Optional[
Union[
str,
RouteOptimizationTransport,
Callable[..., RouteOptimizationTransport],
]
] = "grpc_asyncio",
client_options: Optional[ClientOptions] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the route optimization async client.
Args:
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.
transport (Optional[Union[str,RouteOptimizationTransport,Callable[..., RouteOptimizationTransport]]]):
The transport to use, or a Callable that constructs and returns a new transport to use.
If a Callable is given, it will be called with the same set of initialization
arguments as used in the RouteOptimizationTransport constructor.
If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]):
Custom options for the client.
1. The ``api_endpoint`` property can be used to override the
default endpoint provided by the client when ``transport`` is
not explicitly provided. Only if this property is not set and
``transport`` was not explicitly provided, the endpoint is
determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment
variable, which have one of the following values:
"always" (always use the default mTLS endpoint), "never" (always
use the default regular endpoint) and "auto" (auto-switch to the
default mTLS endpoint if client certificate is present; this is
the default value).
2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
is "true", then the ``client_cert_source`` property can be used
to provide a client certificate for mTLS transport. If
not provided, the default SSL client certificate will be used if
present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not
set, no client certificate will be used.
3. The ``universe_domain`` property can be used to override the
default "googleapis.com" universe. Note that ``api_endpoint``
property still takes precedence; and ``universe_domain`` is
currently not supported for mTLS.
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're developing
your own client library.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
creation failed for any reason.
"""
self._client = RouteOptimizationClient(
credentials=credentials,
transport=transport,
client_options=client_options,
client_info=client_info,
)
[docs] async def optimize_tours(
self,
request: Optional[
Union[route_optimization_service.OptimizeToursRequest, dict]
] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> route_optimization_service.OptimizeToursResponse:
r"""Sends an ``OptimizeToursRequest`` containing a ``ShipmentModel``
and returns an ``OptimizeToursResponse`` containing
``ShipmentRoute``\ s, which are a set of routes to be performed
by vehicles minimizing the overall cost.
A ``ShipmentModel`` model consists mainly of ``Shipment``\ s
that need to be carried out and ``Vehicle``\ s that can be used
to transport the ``Shipment``\ s. The ``ShipmentRoute``\ s
assign ``Shipment``\ s to ``Vehicle``\ s. More specifically,
they assign a series of ``Visit``\ s to each vehicle, where a
``Visit`` corresponds to a ``VisitRequest``, which is a pickup
or delivery for a ``Shipment``.
The goal is to provide an assignment of ``ShipmentRoute``\ s to
``Vehicle``\ s that minimizes the total cost where cost has many
components defined in the ``ShipmentModel``.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import routeoptimization_v1
async def sample_optimize_tours():
# Create a client
client = routeoptimization_v1.RouteOptimizationAsyncClient()
# Initialize request argument(s)
request = routeoptimization_v1.OptimizeToursRequest(
parent="parent_value",
)
# Make the request
response = await client.optimize_tours(request=request)
# Handle the response
print(response)
Args:
request (Optional[Union[google.maps.routeoptimization_v1.types.OptimizeToursRequest, dict]]):
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_async.AsyncRetry): 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:
google.maps.routeoptimization_v1.types.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.
"""
# Create or coerce a protobuf request object.
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(request, route_optimization_service.OptimizeToursRequest):
request = route_optimization_service.OptimizeToursRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.optimize_tours
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._client._validate_universe_domain()
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
[docs] async def batch_optimize_tours(
self,
request: Optional[
Union[route_optimization_service.BatchOptimizeToursRequest, dict]
] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Optimizes vehicle tours for one or more ``OptimizeToursRequest``
messages as a batch.
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
``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.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import routeoptimization_v1
async def sample_batch_optimize_tours():
# Create a client
client = routeoptimization_v1.RouteOptimizationAsyncClient()
# Initialize request argument(s)
model_configs = routeoptimization_v1.AsyncModelConfig()
model_configs.input_config.gcs_source.uri = "uri_value"
model_configs.input_config.data_format = "PROTO_TEXT"
model_configs.output_config.gcs_destination.uri = "uri_value"
model_configs.output_config.data_format = "PROTO_TEXT"
request = routeoptimization_v1.BatchOptimizeToursRequest(
parent="parent_value",
model_configs=model_configs,
)
# Make the request
operation = client.batch_optimize_tours(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Args:
request (Optional[Union[google.maps.routeoptimization_v1.types.BatchOptimizeToursRequest, dict]]):
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_async.AsyncRetry): 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:
google.api_core.operation_async.AsyncOperation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.maps.routeoptimization_v1.types.BatchOptimizeToursResponse` Response to a BatchOptimizeToursRequest. This is returned in
the Long Running Operation after the operation is
complete.
"""
# Create or coerce a protobuf request object.
# - Use the request object if provided (there's no risk of modifying the input as
# there are no flattened fields), or create one.
if not isinstance(
request, route_optimization_service.BatchOptimizeToursRequest
):
request = route_optimization_service.BatchOptimizeToursRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._client._transport._wrapped_methods[
self._client._transport.batch_optimize_tours
]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Validate the universe domain.
self._client._validate_universe_domain()
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation_async.from_gapic(
response,
self._client._transport.operations_client,
route_optimization_service.BatchOptimizeToursResponse,
metadata_type=route_optimization_service.BatchOptimizeToursMetadata,
)
# Done; return the response.
return response
[docs] async def get_operation(
self,
request: Optional[operations_pb2.GetOperationRequest] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operations_pb2.Operation:
r"""Gets the latest state of a long-running operation.
Args:
request (:class:`~.operations_pb2.GetOperationRequest`):
The request object. Request message for
`GetOperation` method.
retry (google.api_core.retry_async.AsyncRetry): 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:
An ``Operation`` object.
"""
# Create or coerce a protobuf request object.
# The request isn't a proto-plus wrapped type,
# so it must be constructed via keyword expansion.
if isinstance(request, dict):
request = operations_pb2.GetOperationRequest(**request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.get_operation,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
)
# Validate the universe domain.
self._client._validate_universe_domain()
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def __aenter__(self) -> "RouteOptimizationAsyncClient":
return self
async def __aexit__(self, exc_type, exc, tb):
await self.transport.close()
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=package_version.__version__
)
__all__ = ("RouteOptimizationAsyncClient",)
