def test_update_instance(self):
# Setup Expected Response
name = 'name3373707'
config = 'config-1354792126'
display_name = 'displayName1615086568'
node_count = 1539922066
expected_response = {
'name': name,
'config': config,
'display_name': display_name,
'node_count': node_count
}
expected_response = spanner_instance_admin_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 = spanner_admin_instance_v1.InstanceAdminClient(channel=channel)
# Setup Request
instance = {}
field_mask = {}
response = client.update_instance(instance, field_mask)
result = response.result()
assert expected_response == result
assert len(channel.requests) == 1
expected_request = spanner_instance_admin_pb2.UpdateInstanceRequest(
instance=instance, field_mask=field_mask)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_update_instance(self, mock_create_stub):
# Mock gRPC layer
grpc_stub = mock.Mock()
mock_create_stub.return_value = grpc_stub
client = spanner_admin_instance_v1.InstanceAdminClient()
# Mock request
instance = {}
field_mask = {}
# Mock response
name = 'name3373707'
config = 'config-1354792126'
display_name = 'displayName1615086568'
node_count = 1539922066
expected_response = {
'name': name,
'config': config,
'display_name': display_name,
'node_count': node_count
}
expected_response = spanner_instance_admin_pb2.Instance(
**expected_response)
operation = operations_pb2.Operation(
name='operations/test_update_instance', done=True)
operation.response.Pack(expected_response)
grpc_stub.UpdateInstance.return_value = operation
response = client.update_instance(instance, field_mask)
self.assertEqual(expected_response, response.result())
grpc_stub.UpdateInstance.assert_called_once()
args, kwargs = grpc_stub.UpdateInstance.call_args
self.assertEqual(len(args), 2)
self.assertEqual(len(kwargs), 1)
self.assertIn('metadata', kwargs)
actual_request = args[0]
expected_request = spanner_instance_admin_pb2.UpdateInstanceRequest(
instance=instance, field_mask=field_mask)
self.assertEqual(expected_request, actual_request)
def test_update_instance(self):
# Setup Expected Response
name = "name3373707"
config = "config-1354792126"
display_name = "displayName1615086568"
node_count = 1539922066
expected_response = {
"name": name,
"config": config,
"display_name": display_name,
"node_count": node_count,
}
expected_response = spanner_instance_admin_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 = spanner_admin_instance_v1.InstanceAdminClient()
# Setup Request
instance = {}
field_mask = {}
response = client.update_instance(instance, field_mask)
result = response.result()
assert expected_response == result
assert len(channel.requests) == 1
expected_request = spanner_instance_admin_pb2.UpdateInstanceRequest(
instance=instance, field_mask=field_mask
)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def update_instance(self,
instance,
field_mask,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Updates an instance, and begins allocating or releasing resources
as requested. The returned [long-running
operation][google.longrunning.Operation] can be used to track the
progress of updating the instance. If the named instance does not
exist, returns ``NOT_FOUND``.
Immediately upon completion of this request:
* For resource types for which a decrease in the instance's allocation
has been requested, billing is based on the newly-requested level.
Until completion of the returned operation:
* Cancelling the operation sets its metadata's
[cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins
restoring resources to their pre-request values. The operation
is guaranteed to succeed at undoing all resource changes,
after which point it terminates with a `CANCELLED` status.
* All other attempts to modify the instance are rejected.
* Reading the instance via the API continues to give the pre-request
resource levels.
Upon completion of the returned operation:
* Billing begins for all successfully-allocated resources (some types
may have lower than the requested levels).
* All newly-reserved resources are available for serving the instance's
tables.
* The instance's new resource levels are readable via the API.
The returned ``long-running operation`` will
have a name of the format ``<instance_name>/operations/<operation_id>`` and
can be used to track the instance modification. The
``metadata`` field type is
``UpdateInstanceMetadata``.
The ``response`` field type is
``Instance``, if successful.
Authorization requires ``spanner.instances.update`` permission on
resource ``name``.
Example:
>>> from google.cloud import spanner_admin_instance_v1
>>>
>>> client = spanner_admin_instance_v1.InstanceAdminClient()
>>>
>>> instance = {}
>>> field_mask = {}
>>>
>>> response = client.update_instance(instance, field_mask)
>>>
>>> def callback(operation_future):
... # Handle result.
... result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()
Args:
instance (Union[dict, ~google.cloud.spanner_admin_instance_v1.types.Instance]): Required. The instance to update, which must always include the instance
name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.spanner_admin_instance_v1.types.Instance`
field_mask (Union[dict, ~google.cloud.spanner_admin_instance_v1.types.FieldMask]): Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
The field mask must always be specified; this prevents any future fields in
[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know
about them.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.spanner_admin_instance_v1.types.FieldMask`
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.
Returns:
A :class:`~google.cloud.spanner_admin_instance_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.
"""
request = spanner_instance_admin_pb2.UpdateInstanceRequest(
instance=instance,
field_mask=field_mask,
)
operation = self._update_instance(request,
retry=retry,
timeout=timeout,
metadata=metadata)
return google.api_core.operation.from_gapic(
operation,
self.operations_client,
spanner_instance_admin_pb2.Instance,
metadata_type=spanner_instance_admin_pb2.UpdateInstanceMetadata,
)
def update_instance(self, instance, field_mask, options=None):
"""
Updates an instance, and begins allocating or releasing resources
as requested. The returned [long-running
operation][google.longrunning.Operation] can be used to track the
progress of updating the instance. If the named instance does not
exist, returns ``NOT_FOUND``.
Immediately upon completion of this request:
* For resource types for which a decrease in the instance's allocation
has been requested, billing is based on the newly-requested level.
Until completion of the returned operation:
* Cancelling the operation sets its metadata's
[cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins
restoring resources to their pre-request values. The operation
is guaranteed to succeed at undoing all resource changes,
after which point it terminates with a `CANCELLED` status.
* All other attempts to modify the instance are rejected.
* Reading the instance via the API continues to give the pre-request
resource levels.
Upon completion of the returned operation:
* Billing begins for all successfully-allocated resources (some types
may have lower than the requested levels).
* All newly-reserved resources are available for serving the instance's
tables.
* The instance's new resource levels are readable via the API.
The returned ``long-running operation`` will
have a name of the format ``<instance_name>/operations/<operation_id>`` and
can be used to track the instance modification. The
``metadata`` field type is
``UpdateInstanceMetadata``.
The ``response`` field type is
``Instance``, if successful.
Authorization requires ``spanner.instances.update`` permission on
resource ``name``.
Example:
>>> from google.cloud import spanner_admin_instance_v1
>>>
>>> client = spanner_admin_instance_v1.InstanceAdminClient()
>>>
>>> instance = {}
>>> field_mask = {}
>>>
>>> response = client.update_instance(instance, field_mask)
>>>
>>> def callback(operation_future):
... # Handle result.
... result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()
Args:
instance (Union[dict, ~google.cloud.spanner_admin_instance_v1.types.Instance]): Required. The instance to update, which must always include the instance
name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.spanner_admin_instance_v1.types.Instance`
field_mask (Union[dict, ~google.cloud.spanner_admin_instance_v1.types.FieldMask]): Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
The field mask must always be specified; this prevents any future fields in
[][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know
about them.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.spanner_admin_instance_v1.types.FieldMask`
options (~google.gax.CallOptions): Overrides the default
settings for this call, e.g, timeout, retries etc.
Returns:
A :class:`~google.cloud.spanner_admin_instance_v1.types._OperationFuture` instance.
Raises:
:exc:`google.gax.errors.GaxError` if the RPC is aborted.
:exc:`ValueError` if the parameters are invalid.
"""
request = spanner_instance_admin_pb2.UpdateInstanceRequest(
instance=instance, field_mask=field_mask)
return google.gax._OperationFuture(
self._update_instance(request, options), self.operations_client,
spanner_instance_admin_pb2.Instance,
spanner_instance_admin_pb2.UpdateInstanceMetadata, options)