def test_get_instance_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.get_instance(cloud_memcache.GetInstanceRequest(), name="name_value")
def test_get_instance(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.GetInstanceRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_instance), "__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = cloud_memcache.Instance(
name="name_value",
display_name="display_name_value",
authorized_network="authorized_network_value",
zones=["zones_value"],
node_count=1070,
memcache_version=cloud_memcache.MemcacheVersion.MEMCACHE_1_5,
state=cloud_memcache.Instance.State.CREATING,
memcache_full_version="memcache_full_version_value",
discovery_endpoint="discovery_endpoint_value",
)
response = client.get_instance(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, cloud_memcache.Instance)
assert response.name == "name_value"
assert response.display_name == "display_name_value"
assert response.authorized_network == "authorized_network_value"
assert response.zones == ["zones_value"]
assert response.node_count == 1070
assert response.memcache_version == cloud_memcache.MemcacheVersion.MEMCACHE_1_5
assert response.state == cloud_memcache.Instance.State.CREATING
assert response.memcache_full_version == "memcache_full_version_value"
assert response.discovery_endpoint == "discovery_endpoint_value"
def test_get_instance_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.GetInstanceRequest(name="name/value")
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.get_instance), "__call__") as call:
call.return_value = cloud_memcache.Instance()
client.get_instance(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", "name=name/value") in kw["metadata"]
def get_instance(
self,
request: cloud_memcache.GetInstanceRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cloud_memcache.Instance:
r"""Gets details of a single Instance.
Args:
request (:class:`~.cloud_memcache.GetInstanceRequest`):
The request object. Request for
[GetInstance][google.cloud.memcache.v1beta2.CloudMemcache.GetInstance].
name (:class:`str`):
Required. Memcached instance resource name in the
format:
``projects/{project_id}/locations/{location_id}/instances/{instance_id}``
where ``location_id`` refers to a GCP region
This corresponds to the ``name`` 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:
~.cloud_memcache.Instance:
"""
# 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([name]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = cloud_memcache.GetInstanceRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(self._transport.get_instance,
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(
(("name", request.name), )), )
# Send the request.
response = rpc(request,
retry=retry,
timeout=timeout,
metadata=metadata)
# Done; return the response.
return response
def get_instance(
self,
request: cloud_memcache.GetInstanceRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cloud_memcache.Instance:
r"""Gets details of a single Instance.
Args:
request (google.cloud.memcache_v1beta2.types.GetInstanceRequest):
The request object. Request for
[GetInstance][google.cloud.memcache.v1beta2.CloudMemcache.GetInstance].
name (str):
Required. Memcached instance resource name in the
format:
``projects/{project_id}/locations/{location_id}/instances/{instance_id}``
where ``location_id`` refers to a GCP region
This corresponds to the ``name`` 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:
google.cloud.memcache_v1beta2.types.Instance:
A Memorystore for Memcached instance
"""
# 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.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a cloud_memcache.GetInstanceRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, cloud_memcache.GetInstanceRequest):
request = cloud_memcache.GetInstanceRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_instance]
# 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), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response