def test_create_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
parent = client.project_path('[PROJECT]')
instance_id = 'instanceId-2101995259'
instance = {}
# 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_create_instance', done=True)
operation.response.Pack(expected_response)
grpc_stub.CreateInstance.return_value = operation
response = client.create_instance(parent, instance_id, instance)
self.assertEqual(expected_response, response.result())
grpc_stub.CreateInstance.assert_called_once()
args, kwargs = grpc_stub.CreateInstance.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.CreateInstanceRequest(
parent=parent, instance_id=instance_id, instance=instance)
self.assertEqual(expected_request, actual_request)
def test_create_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_create_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
parent = client.project_path("[PROJECT]")
instance_id = "instanceId-2101995259"
instance = {}
response = client.create_instance(parent, instance_id, instance)
result = response.result()
assert expected_response == result
assert len(channel.requests) == 1
expected_request = spanner_instance_admin_pb2.CreateInstanceRequest(
parent=parent, instance_id=instance_id, instance=instance
)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_create_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_create_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
parent = client.project_path('[PROJECT]')
instance_id = 'instanceId-2101995259'
instance = {}
response = client.create_instance(parent, instance_id, instance)
result = response.result()
assert expected_response == result
assert len(channel.requests) == 1
expected_request = spanner_instance_admin_pb2.CreateInstanceRequest(
parent=parent, instance_id=instance_id, instance=instance)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def create_instance(self,
parent,
instance_id,
instance,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Creates an instance and begins preparing it to begin serving. The
returned ``long-running operation``
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists, ``CreateInstance`` returns
``ALREADY_EXISTS``.
Immediately upon completion of this request:
* The instance is readable via the API, with all requested attributes
but no allocated resources. Its state is `CREATING`.
Until completion of the returned operation:
* Cancelling the operation renders the instance immediately unreadable
via the API.
* The instance can be deleted.
* All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
* Billing for all successfully-allocated resources begins (some types
may have lower than the requested levels).
* Databases can be created in the instance.
* The instance's allocated resource levels are readable via the API.
* The instance's state becomes ``READY``.
The returned ``long-running operation`` will
have a name of the format ``<instance_name>/operations/<operation_id>`` and
can be used to track creation of the instance. The
``metadata`` field type is
``CreateInstanceMetadata``.
The ``response`` field type is
``Instance``, if successful.
Example:
>>> from google.cloud import spanner_admin_instance_v1
>>>
>>> client = spanner_admin_instance_v1.InstanceAdminClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>> instance_id = ''
>>> instance = {}
>>>
>>> response = client.create_instance(parent, instance_id, instance)
>>>
>>> def callback(operation_future):
... # Handle result.
... result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()
Args:
parent (str): Required. The name of the project in which to create the instance. Values
are of the form ``projects/<project>``.
instance_id (str): Required. The ID of the instance to create. Valid identifiers are of the
form ``[a-z][-a-z0-9]*[a-z0-9]`` and must be between 6 and 30 characters in
length.
instance (Union[dict, ~google.cloud.spanner_admin_instance_v1.types.Instance]): Required. The instance to create. The name may be omitted, but if
specified must be ``<parent>/instances/<instance_id>``.
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`
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.CreateInstanceRequest(
parent=parent,
instance_id=instance_id,
instance=instance,
)
operation = self._create_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.CreateInstanceMetadata,
)
def create_instance(self, parent, instance_id, instance, options=None):
"""
Creates an instance and begins preparing it to begin serving. The
returned ``long-running operation``
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists, ``CreateInstance`` returns
``ALREADY_EXISTS``.
Immediately upon completion of this request:
* The instance is readable via the API, with all requested attributes
but no allocated resources. Its state is `CREATING`.
Until completion of the returned operation:
* Cancelling the operation renders the instance immediately unreadable
via the API.
* The instance can be deleted.
* All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
* Billing for all successfully-allocated resources begins (some types
may have lower than the requested levels).
* Databases can be created in the instance.
* The instance's allocated resource levels are readable via the API.
* The instance's state becomes ``READY``.
The returned ``long-running operation`` will
have a name of the format ``<instance_name>/operations/<operation_id>`` and
can be used to track creation of the instance. The
``metadata`` field type is
``CreateInstanceMetadata``.
The ``response`` field type is
``Instance``, if successful.
Example:
>>> from google.cloud import spanner_admin_instance_v1
>>>
>>> client = spanner_admin_instance_v1.InstanceAdminClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>> instance_id = ''
>>> instance = {}
>>>
>>> response = client.create_instance(parent, instance_id, instance)
>>>
>>> def callback(operation_future):
... # Handle result.
... result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()
Args:
parent (str): Required. The name of the project in which to create the instance. Values
are of the form ``projects/<project>``.
instance_id (str): Required. The ID of the instance to create. Valid identifiers are of the
form ``[a-z][-a-z0-9]*[a-z0-9]`` and must be between 6 and 30 characters in
length.
instance (Union[dict, ~google.cloud.spanner_admin_instance_v1.types.Instance]): Required. The instance to create. The name may be omitted, but if
specified must be ``<parent>/instances/<instance_id>``.
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`
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.CreateInstanceRequest(
parent=parent, instance_id=instance_id, instance=instance)
return google.gax._OperationFuture(
self._create_instance(request, options), self.operations_client,
spanner_instance_admin_pb2.Instance,
spanner_instance_admin_pb2.CreateInstanceMetadata, options)