def delete_key(
self,
request: recaptchaenterprise.DeleteKeyRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes the specified key.
Args:
request (:class:`~.recaptchaenterprise.DeleteKeyRequest`):
The request object. The delete key request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
# Create or coerce a protobuf request object.
request = recaptchaenterprise.DeleteKeyRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(self._transport.delete_key,
default_timeout=None,
client_info=_client_info)
# Send the request.
rpc(request, retry=retry, timeout=timeout, metadata=metadata)
def delete_key(
self,
request: recaptchaenterprise.DeleteKeyRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes the specified key.
Args:
request (google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest):
The request object. The delete key request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
# Create or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a recaptchaenterprise.DeleteKeyRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, recaptchaenterprise.DeleteKeyRequest):
request = recaptchaenterprise.DeleteKeyRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_key]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
async def delete_key(
self,
request: recaptchaenterprise.DeleteKeyRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes the specified key.
Args:
request (:class:`google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest`):
The request object. The delete key request message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
# Create or coerce a protobuf request object.
request = recaptchaenterprise.DeleteKeyRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.delete_key,
default_timeout=600.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
def test_delete_key(transport: str = "grpc"):
client = RecaptchaEnterpriseServiceClient(
credentials=credentials.AnonymousCredentials(), transport=transport
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = recaptchaenterprise.DeleteKeyRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.delete_key), "__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = None
response = client.delete_key(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert response is None