def test_list_instances(transport: str = "grpc"):
client = CloudMemcacheClient(
credentials=credentials.AnonymousCredentials(), transport=transport
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = cloud_memcache.ListInstancesRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_instances), "__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = cloud_memcache.ListInstancesResponse(
next_page_token="next_page_token_value", unreachable=["unreachable_value"]
)
response = client.list_instances(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert isinstance(response, pagers.ListInstancesPager)
assert response.next_page_token == "next_page_token_value"
assert response.unreachable == ["unreachable_value"]
def test_list_instances_flattened_error():
client = CloudMemcacheClient(credentials=credentials.AnonymousCredentials())
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.list_instances(
cloud_memcache.ListInstancesRequest(), parent="parent_value"
)
def __init__(
self,
method: Callable[[cloud_memcache.ListInstancesRequest],
cloud_memcache.ListInstancesResponse],
request: cloud_memcache.ListInstancesRequest,
response: cloud_memcache.ListInstancesResponse,
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (:class:`~.cloud_memcache.ListInstancesRequest`):
The initial request object.
response (:class:`~.cloud_memcache.ListInstancesResponse`):
The initial response object.
"""
self._method = method
self._request = cloud_memcache.ListInstancesRequest(request)
self._response = response
def test_list_instances_field_headers():
client = CloudMemcacheClient(credentials=credentials.AnonymousCredentials())
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = cloud_memcache.ListInstancesRequest(parent="parent/value")
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_instances), "__call__") as call:
call.return_value = cloud_memcache.ListInstancesResponse()
client.list_instances(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert ("x-goog-request-params", "parent=parent/value") in kw["metadata"]
def __init__(self,
method: Callable[..., cloud_memcache.ListInstancesResponse],
request: cloud_memcache.ListInstancesRequest,
response: cloud_memcache.ListInstancesResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.cloud.memcache_v1beta2.types.ListInstancesRequest):
The initial request object.
response (google.cloud.memcache_v1beta2.types.ListInstancesResponse):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = cloud_memcache.ListInstancesRequest(request)
self._response = response
self._metadata = metadata
def list_instances(
self,
request: cloud_memcache.ListInstancesRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListInstancesPager:
r"""Lists Instances in a given project and location.
Args:
request (:class:`~.cloud_memcache.ListInstancesRequest`):
The request object. Request for
[ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].
parent (:class:`str`):
Required. The resource name of the instance location
using the form:
``projects/{project_id}/locations/{location_id}`` where
``location_id`` refers to a GCP region
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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:
~.pagers.ListInstancesPager:
Response for
[ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any([parent]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = cloud_memcache.ListInstancesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.list_instances,
default_timeout=None,
client_info=_client_info,
)
# 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), )), )
# Send the request.
response = rpc(request,
retry=retry,
timeout=timeout,
metadata=metadata)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListInstancesPager(method=rpc,
request=request,
response=response)
# Done; return the response.
return response
