From 895cbec764f18fd5b775e0544d1eb0ac9506acab Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Tue, 30 Jul 2024 10:17:32 -0400 Subject: [PATCH] docs: [google-maps-fleetengine-delivery] document that delivery_vehicle.type can be set on CreateDeliveryVehicle (#12959) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 657296410 Source-Link: https://github.com/googleapis/googleapis/commit/05e80312954b2a2e18c6067509bff5c1f9c38846 Source-Link: https://github.com/googleapis/googleapis-gen/commit/92547f13e10f4fddc5e907ed992712382c5d26a0 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtZmxlZXRlbmdpbmUtZGVsaXZlcnkvLk93bEJvdC55YW1sIiwiaCI6IjkyNTQ3ZjEzZTEwZjRmZGRjNWU5MDdlZDk5MjcxMjM4MmM1ZDI2YTAifQ== --------- Co-authored-by: Owl Bot Co-authored-by: Anthonios Partheniou --- .../fleetengine_delivery/gapic_version.py | 2 +- .../fleetengine_delivery_v1/gapic_version.py | 2 +- .../services/delivery_service/async_client.py | 5 ++ .../services/delivery_service/client.py | 5 ++ .../services/delivery_service/pagers.py | 70 +++++++++++++++++-- .../types/delivery_api.py | 1 + ...metadata_maps.fleetengine.delivery.v1.json | 2 +- .../test_delivery_service.py | 13 +++- 8 files changed, 91 insertions(+), 9 deletions(-) diff --git a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery/gapic_version.py b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery/gapic_version.py index d1a1a883babd..558c8aab67c5 100644 --- a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery/gapic_version.py +++ b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.2.2" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/gapic_version.py b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/gapic_version.py index d1a1a883babd..558c8aab67c5 100644 --- a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/gapic_version.py +++ b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.2.2" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/async_client.py b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/async_client.py index a43c91644660..dea953e2e407 100644 --- a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/async_client.py +++ b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/async_client.py @@ -340,6 +340,7 @@ async def sample_create_delivery_vehicle(): creating a new delivery vehicle, you may set the following optional fields: + - type - last_location - attributes @@ -1339,6 +1340,8 @@ async def sample_list_tasks(): method=rpc, request=request, response=response, + retry=retry, + timeout=timeout, metadata=metadata, ) @@ -1571,6 +1574,8 @@ async def sample_list_delivery_vehicles(): method=rpc, request=request, response=response, + retry=retry, + timeout=timeout, metadata=metadata, ) diff --git a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/client.py b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/client.py index 00206905b8ed..d58160d8d51c 100644 --- a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/client.py +++ b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/client.py @@ -783,6 +783,7 @@ def sample_create_delivery_vehicle(): creating a new delivery vehicle, you may set the following optional fields: + - type - last_location - attributes @@ -1805,6 +1806,8 @@ def sample_list_tasks(): method=rpc, request=request, response=response, + retry=retry, + timeout=timeout, metadata=metadata, ) @@ -2043,6 +2046,8 @@ def sample_list_delivery_vehicles(): method=rpc, request=request, response=response, + retry=retry, + timeout=timeout, metadata=metadata, ) diff --git a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/pagers.py b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/pagers.py index 70f7e807101b..b645b3ca097f 100644 --- a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/pagers.py +++ b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/services/delivery_service/pagers.py @@ -22,8 +22,22 @@ Optional, Sequence, Tuple, + Union, ) +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import retry_async as retries_async + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] + OptionalAsyncRetry = Union[ + retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None + ] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None] # type: ignore + from google.maps.fleetengine_delivery_v1.types import ( delivery_api, delivery_vehicles, @@ -55,6 +69,8 @@ def __init__( request: delivery_api.ListTasksRequest, response: delivery_api.ListTasksResponse, *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. @@ -66,12 +82,17 @@ def __init__( The initial request object. response (google.maps.fleetengine_delivery_v1.types.ListTasksResponse): The initial response object. + 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. """ self._method = method self._request = delivery_api.ListTasksRequest(request) self._response = response + self._retry = retry + self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: @@ -82,7 +103,12 @@ def pages(self) -> Iterator[delivery_api.ListTasksResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) yield self._response def __iter__(self) -> Iterator[tasks.Task]: @@ -117,6 +143,8 @@ def __init__( request: delivery_api.ListTasksRequest, response: delivery_api.ListTasksResponse, *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiates the pager. @@ -128,12 +156,17 @@ def __init__( The initial request object. response (google.maps.fleetengine_delivery_v1.types.ListTasksResponse): The initial response object. + retry (google.api_core.retry.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. """ self._method = method self._request = delivery_api.ListTasksRequest(request) self._response = response + self._retry = retry + self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: @@ -144,7 +177,12 @@ async def pages(self) -> AsyncIterator[delivery_api.ListTasksResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) + self._response = await self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) yield self._response def __aiter__(self) -> AsyncIterator[tasks.Task]: @@ -183,6 +221,8 @@ def __init__( request: delivery_api.ListDeliveryVehiclesRequest, response: delivery_api.ListDeliveryVehiclesResponse, *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. @@ -194,12 +234,17 @@ def __init__( The initial request object. response (google.maps.fleetengine_delivery_v1.types.ListDeliveryVehiclesResponse): The initial response object. + 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. """ self._method = method self._request = delivery_api.ListDeliveryVehiclesRequest(request) self._response = response + self._retry = retry + self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: @@ -210,7 +255,12 @@ def pages(self) -> Iterator[delivery_api.ListDeliveryVehiclesResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) yield self._response def __iter__(self) -> Iterator[delivery_vehicles.DeliveryVehicle]: @@ -245,6 +295,8 @@ def __init__( request: delivery_api.ListDeliveryVehiclesRequest, response: delivery_api.ListDeliveryVehiclesResponse, *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiates the pager. @@ -256,12 +308,17 @@ def __init__( The initial request object. response (google.maps.fleetengine_delivery_v1.types.ListDeliveryVehiclesResponse): The initial response object. + retry (google.api_core.retry.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. """ self._method = method self._request = delivery_api.ListDeliveryVehiclesRequest(request) self._response = response + self._retry = retry + self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: @@ -272,7 +329,12 @@ async def pages(self) -> AsyncIterator[delivery_api.ListDeliveryVehiclesResponse yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) + self._response = await self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) yield self._response def __aiter__(self) -> AsyncIterator[delivery_vehicles.DeliveryVehicle]: diff --git a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/types/delivery_api.py b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/types/delivery_api.py index 39f2254f731f..a8e773aae506 100644 --- a/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/types/delivery_api.py +++ b/packages/google-maps-fleetengine-delivery/google/maps/fleetengine_delivery_v1/types/delivery_api.py @@ -73,6 +73,7 @@ class CreateDeliveryVehicleRequest(proto.Message): creating a new delivery vehicle, you may set the following optional fields: + - type - last_location - attributes diff --git a/packages/google-maps-fleetengine-delivery/samples/generated_samples/snippet_metadata_maps.fleetengine.delivery.v1.json b/packages/google-maps-fleetengine-delivery/samples/generated_samples/snippet_metadata_maps.fleetengine.delivery.v1.json index 647fd142cba2..884ac226d0e4 100644 --- a/packages/google-maps-fleetengine-delivery/samples/generated_samples/snippet_metadata_maps.fleetengine.delivery.v1.json +++ b/packages/google-maps-fleetengine-delivery/samples/generated_samples/snippet_metadata_maps.fleetengine.delivery.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-maps-fleetengine-delivery", - "version": "0.2.2" + "version": "0.1.0" }, "snippets": [ { diff --git a/packages/google-maps-fleetengine-delivery/tests/unit/gapic/fleetengine_delivery_v1/test_delivery_service.py b/packages/google-maps-fleetengine-delivery/tests/unit/gapic/fleetengine_delivery_v1/test_delivery_service.py index cfee83e78c3b..741041daa2d9 100644 --- a/packages/google-maps-fleetengine-delivery/tests/unit/gapic/fleetengine_delivery_v1/test_delivery_service.py +++ b/packages/google-maps-fleetengine-delivery/tests/unit/gapic/fleetengine_delivery_v1/test_delivery_service.py @@ -29,6 +29,7 @@ from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template from google.api_core import api_core_version, client_options from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError @@ -4021,9 +4022,13 @@ def test_list_tasks_pager(transport_name: str = "grpc"): ) expected_metadata = () - pager = client.list_tasks(request={}) + retry = retries.Retry() + timeout = 5 + pager = client.list_tasks(request={}, retry=retry, timeout=timeout) assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout results = list(pager) assert len(results) == 6 @@ -4934,9 +4939,13 @@ def test_list_delivery_vehicles_pager(transport_name: str = "grpc"): ) expected_metadata = () - pager = client.list_delivery_vehicles(request={}) + retry = retries.Retry() + timeout = 5 + pager = client.list_delivery_vehicles(request={}, retry=retry, timeout=timeout) assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout results = list(pager) assert len(results) == 6