Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [google-maps-fleetengine-delivery] document that delivery_vehicle.type can be set on CreateDeliveryVehicle #12959

Merged
merged 3 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -1339,6 +1340,8 @@ async def sample_list_tasks():
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)

Expand Down Expand Up @@ -1571,6 +1574,8 @@ async def sample_list_delivery_vehicles():
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -1805,6 +1806,8 @@ def sample_list_tasks():
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)

Expand Down Expand Up @@ -2043,6 +2046,8 @@ def sample_list_delivery_vehicles():
method=rpc,
request=request,
response=response,
retry=retry,
timeout=timeout,
metadata=metadata,
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand All @@ -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]:
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand All @@ -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]:
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand All @@ -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]:
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand All @@ -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]:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ class CreateDeliveryVehicleRequest(proto.Message):
creating a new delivery vehicle, you may set the following
optional fields:

- type
- last_location
- attributes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-maps-fleetengine-delivery",
"version": "0.2.2"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading