def test_export_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) operation = operations_pb2.Operation( name="operations/test_export_instance", done=True ) operation.response.Pack(expected_response) # Mock the API response channel = ChannelStub(responses=[operation]) patch = mock.patch("google.api_core.grpc_helpers.create_channel") with patch as create_channel: create_channel.return_value = channel client = redis_v1.CloudRedisClient() # Setup Request name = "name3373707" output_config = {} response = client.export_instance(name, output_config) result = response.result() assert expected_response == result assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.ExportInstanceRequest( name=name, output_config=output_config ) actual_request = channel.requests[0][1] assert expected_request == actual_request
def export_instance( self, name, output_config, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None, ): """ Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. Example: >>> from google.cloud import redis_v1 >>> >>> client = redis_v1.CloudRedisClient() >>> >>> name = client.instance_path('[PROJECT]', '[LOCATION]', '[INSTANCE]') >>> >>> # TODO: Initialize `output_config`: >>> output_config = {} >>> >>> response = client.export_instance(name, output_config) >>> >>> def callback(operation_future): ... # Handle result. ... result = operation_future.result() >>> >>> response.add_done_callback(callback) >>> >>> # Handle metadata. >>> metadata = response.metadata() 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. output_config (Union[dict, ~google.cloud.redis_v1.types.OutputConfig]): Required. Specify data to be exported. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.redis_v1.types.OutputConfig` 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_v1.types._OperationFuture` 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 "export_instance" not in self._inner_api_calls: self._inner_api_calls[ "export_instance"] = google.api_core.gapic_v1.method.wrap_method( self.transport.export_instance, default_retry=self._method_configs["ExportInstance"].retry, default_timeout=self._method_configs["ExportInstance"]. timeout, client_info=self._client_info, ) request = cloud_redis_pb2.ExportInstanceRequest( name=name, output_config=output_config) if metadata is None: metadata = [] metadata = list(metadata) try: routing_header = [("name", name)] except AttributeError: pass else: routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata( routing_header) metadata.append(routing_metadata) operation = self._inner_api_calls["export_instance"](request, retry=retry, timeout=timeout, metadata=metadata) return google.api_core.operation.from_gapic( operation, self.transport._operations_client, cloud_redis_pb2.Instance, metadata_type=cloud_redis_pb2.OperationMetadata, )