def test_delete_index(self):
channel = ChannelStub()
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = firestore_admin_v1.FirestoreAdminClient()
# Setup Request
name = client.index_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]",
"[INDEX_ID]")
client.delete_index(name)
assert len(channel.requests) == 1
expected_request = firestore_admin_pb2.DeleteIndexRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def delete_index(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes a composite index.
Example:
>>> from google.cloud import firestore_admin_v1
>>>
>>> client = firestore_admin_v1.FirestoreAdminClient()
>>>
>>> name = client.index_path('[PROJECT]', '[DATABASE]', '[COLLECTION_ID]', '[INDEX_ID]')
>>>
>>> client.delete_index(name)
Args:
name (str): Required. A name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
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.
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 "delete_index" not in self._inner_api_calls:
self._inner_api_calls[
"delete_index"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.delete_index,
default_retry=self._method_configs["DeleteIndex"].retry,
default_timeout=self._method_configs["DeleteIndex"].
timeout,
client_info=self._client_info,
)
request = firestore_admin_pb2.DeleteIndexRequest(name=name)
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)
self._inner_api_calls["delete_index"](request,
retry=retry,
timeout=timeout,
metadata=metadata)