def get_instance( self, name, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None, ): """ Gets the details of a specific Redis instance. Example: >>> from google.cloud import redis_v1beta1 >>> >>> client = redis_v1beta1.CloudRedisClient() >>> >>> name = client.instance_path('[PROJECT]', '[LOCATION]', '[INSTANCE]') >>> >>> response = client.get_instance(name) Args: name (str): Required. Redis instance resource name using the form: ``projects/{project_id}/locations/{location_id}/instances/{instance_id}`` where ``location_id`` refers to a GCP region retry (Optional[google.api_core.retry.Retry]): A retry object used to retry requests. If ``None`` is specified, requests will not be retried. timeout (Optional[float]): The amount of time, in seconds, to wait for the request to complete. Note that if ``retry`` is specified, the timeout applies to each individual attempt. metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata that is provided to the method. Returns: A :class:`~google.cloud.redis_v1beta1.types.Instance` instance. Raises: google.api_core.exceptions.GoogleAPICallError: If the request failed for any reason. google.api_core.exceptions.RetryError: If the request failed due to a retryable error and retry attempts failed. ValueError: If the parameters are invalid. """ # Wrap the transport method to add retry and timeout logic. if "get_instance" not in self._inner_api_calls: self._inner_api_calls[ "get_instance"] = google.api_core.gapic_v1.method.wrap_method( self.transport.get_instance, default_retry=self._method_configs["GetInstance"].retry, default_timeout=self._method_configs["GetInstance"]. timeout, client_info=self._client_info, ) request = cloud_redis_pb2.GetInstanceRequest(name=name) return self._inner_api_calls["get_instance"](request, retry=retry, timeout=timeout, metadata=metadata)
def test_get_instance(self): # Setup Expected Response name_2 = "name2-1052831874" display_name = "displayName1615086568" location_id = "locationId552319461" alternative_location_id = "alternativeLocationId-718920621" redis_version = "redisVersion-685310444" reserved_ip_range = "reservedIpRange-1082940580" host = "host3208616" port = 3446913 current_location_id = "currentLocationId1312712735" status_message = "statusMessage-239442758" memory_size_gb = 34199707 authorized_network = "authorizedNetwork-1733809270" persistence_iam_identity = "persistenceIamIdentity1061944584" expected_response = { "name": name_2, "display_name": display_name, "location_id": location_id, "alternative_location_id": alternative_location_id, "redis_version": redis_version, "reserved_ip_range": reserved_ip_range, "host": host, "port": port, "current_location_id": current_location_id, "status_message": status_message, "memory_size_gb": memory_size_gb, "authorized_network": authorized_network, "persistence_iam_identity": persistence_iam_identity, } expected_response = cloud_redis_pb2.Instance(**expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) patch = mock.patch("google.api_core.grpc_helpers.create_channel") with patch as create_channel: create_channel.return_value = channel client = redis_v1beta1.CloudRedisClient() # Setup Request name = client.instance_path("[PROJECT]", "[LOCATION]", "[INSTANCE]") response = client.get_instance(name) assert expected_response == response assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.GetInstanceRequest(name=name) actual_request = channel.requests[0][1] assert expected_request == actual_request
def test_get_instance(self): # Setup Expected Response name_2 = 'name2-1052831874' display_name = 'displayName1615086568' location_id = 'locationId552319461' alternative_location_id = 'alternativeLocationId-718920621' redis_version = 'redisVersion-685310444' reserved_ip_range = 'reservedIpRange-1082940580' host = 'host3208616' port = 3446913 current_location_id = 'currentLocationId1312712735' status_message = 'statusMessage-239442758' memory_size_gb = 34199707 authorized_network = 'authorizedNetwork-1733809270' expected_response = { 'name': name_2, 'display_name': display_name, 'location_id': location_id, 'alternative_location_id': alternative_location_id, 'redis_version': redis_version, 'reserved_ip_range': reserved_ip_range, 'host': host, 'port': port, 'current_location_id': current_location_id, 'status_message': status_message, 'memory_size_gb': memory_size_gb, 'authorized_network': authorized_network } expected_response = cloud_redis_pb2.Instance(**expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) patch = mock.patch('google.api_core.grpc_helpers.create_channel') with patch as create_channel: create_channel.return_value = channel client = redis_v1beta1.CloudRedisClient() # Setup Request name = client.instance_path('[PROJECT]', '[LOCATION]', '[INSTANCE]') response = client.get_instance(name) assert expected_response == response assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.GetInstanceRequest(name=name) actual_request = channel.requests[0][1] assert expected_request == actual_request