def test_update_instance(self): # Setup Expected Response name = 'name3373707' display_name_2 = 'displayName21615000987' 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_2 = 1493816946 authorized_network = 'authorizedNetwork-1733809270' expected_response = { 'name': name, 'display_name': display_name_2, '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_2, 'authorized_network': authorized_network } expected_response = cloud_redis_pb2.Instance(**expected_response) operation = operations_pb2.Operation( name='operations/test_update_instance', done=True) operation.response.Pack(expected_response) # Mock the API response channel = ChannelStub(responses=[operation]) client = redis_v1beta1.CloudRedisClient(channel=channel) # Setup Request paths_element = 'display_name' paths_element_2 = 'memory_size_gb' paths = [paths_element, paths_element_2] update_mask = {'paths': paths} display_name = 'UpdatedDisplayName' memory_size_gb = 4 instance = { 'display_name': display_name, 'memory_size_gb': memory_size_gb } response = client.update_instance(update_mask, instance) result = response.result() assert expected_response == result assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.UpdateInstanceRequest( update_mask=update_mask, instance=instance) actual_request = channel.requests[0][1] assert expected_request == actual_request
def update_instance( self, update_mask, instance, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None, ): """ Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. Example: >>> from google.cloud import redis_v1beta1 >>> >>> client = redis_v1beta1.CloudRedisClient() >>> >>> paths_element = 'display_name' >>> paths_element_2 = 'memory_size_gb' >>> paths = [paths_element, paths_element_2] >>> update_mask = {'paths': paths} >>> display_name = 'UpdatedDisplayName' >>> name = 'projects/<project-name>/locations/<location>/instances/<instance>' >>> memory_size_gb = 4 >>> instance = {'display_name': display_name, 'name': name, 'memory_size_gb': memory_size_gb} >>> >>> response = client.update_instance(update_mask, instance) >>> >>> def callback(operation_future): ... # Handle result. ... result = operation_future.result() >>> >>> response.add_done_callback(callback) >>> >>> # Handle metadata. >>> metadata = response.metadata() Args: update_mask (Union[dict, ~google.cloud.redis_v1beta1.types.FieldMask]): Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from ``Instance``: - ``displayName`` - ``labels`` - ``memorySizeGb`` - ``redisConfig`` If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.redis_v1beta1.types.FieldMask` instance (Union[dict, ~google.cloud.redis_v1beta1.types.Instance]): Required. Update description. Only fields specified in update\_mask are updated. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.redis_v1beta1.types.Instance` retry (Optional[google.api_core.retry.Retry]): A retry object used to retry requests. If ``None`` is specified, requests will be retried using a default configuration. 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._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 "update_instance" not in self._inner_api_calls: self._inner_api_calls[ "update_instance" ] = google.api_core.gapic_v1.method.wrap_method( self.transport.update_instance, default_retry=self._method_configs["UpdateInstance"].retry, default_timeout=self._method_configs["UpdateInstance"].timeout, client_info=self._client_info, ) request = cloud_redis_pb2.UpdateInstanceRequest( update_mask=update_mask, instance=instance ) if metadata is None: metadata = [] metadata = list(metadata) try: routing_header = [("instance.name", instance.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["update_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=any_pb2.Any, )
def test_update_instance(self): # Setup Expected Response name = "name3373707" display_name_2 = "displayName21615000987" 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_2 = 1493816946 authorized_network = "authorizedNetwork-1733809270" expected_response = { "name": name, "display_name": display_name_2, "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_2, "authorized_network": authorized_network, } expected_response = cloud_redis_pb2.Instance(**expected_response) operation = operations_pb2.Operation( name="operations/test_update_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_v1beta1.CloudRedisClient() # Setup Request paths_element = "display_name" paths_element_2 = "memory_size_gb" paths = [paths_element, paths_element_2] update_mask = {"paths": paths} display_name = "UpdatedDisplayName" memory_size_gb = 4 instance = { "display_name": display_name, "memory_size_gb": memory_size_gb } response = client.update_instance(update_mask, instance) result = response.result() assert expected_response == result assert len(channel.requests) == 1 expected_request = cloud_redis_pb2.UpdateInstanceRequest( update_mask=update_mask, instance=instance) actual_request = channel.requests[0][1] assert expected_request == actual_request