async def test_search_uris_async(transport: str = "grpc_asyncio"):
client = WebRiskServiceAsyncClient(
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 = webrisk.SearchUrisRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._client._transport.search_uris),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
webrisk.SearchUrisResponse())
response = await client.search_uris(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert isinstance(response, webrisk.SearchUrisResponse)
async def test_search_uris_flattened_error_async():
client = WebRiskServiceAsyncClient(
credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
await client.search_uris(
webrisk.SearchUrisRequest(),
uri="uri_value",
threat_types=[webrisk.ThreatType.MALWARE],
)
async def search_uris(
self,
request: webrisk.SearchUrisRequest = None,
*,
uri: str = None,
threat_types: Sequence[webrisk.ThreatType] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> webrisk.SearchUrisResponse:
r"""This method is used to check whether a URI is on a
given threatList. Multiple threatLists may be searched
in a single query. The response will list all requested
threatLists the URI was found to match. If the URI is
not found on any of the requested ThreatList an empty
response will be returned.
Args:
request (:class:`~.webrisk.SearchUrisRequest`):
The request object. Request to check URI entries against
threatLists.
uri (:class:`str`):
Required. The URI to be checked for
matches.
This corresponds to the ``uri`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
threat_types (:class:`Sequence[~.webrisk.ThreatType]`):
Required. The ThreatLists to search
in. Multiple ThreatLists may be
specified.
This corresponds to the ``threat_types`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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.
Returns:
~.webrisk.SearchUrisResponse:
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any([uri, threat_types]):
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
request = webrisk.SearchUrisRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if uri is not None:
request.uri = uri
if threat_types is not None:
request.threat_types = threat_types
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.search_uris,
default_timeout=None,
client_info=_client_info,
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
def search_uris(
self,
request: webrisk.SearchUrisRequest = None,
*,
uri: str = None,
threat_types: Sequence[webrisk.ThreatType] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> webrisk.SearchUrisResponse:
r"""This method is used to check whether a URI is on a
given threatList. Multiple threatLists may be searched
in a single query. The response will list all requested
threatLists the URI was found to match. If the URI is
not found on any of the requested ThreatList an empty
response will be returned.
Args:
request (google.cloud.webrisk_v1.types.SearchUrisRequest):
The request object. Request to check URI entries against
threatLists.
uri (str):
Required. The URI to be checked for
matches.
This corresponds to the ``uri`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
threat_types (Sequence[google.cloud.webrisk_v1.types.ThreatType]):
Required. The ThreatLists to search
in. Multiple ThreatLists may be
specified.
This corresponds to the ``threat_types`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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.
Returns:
google.cloud.webrisk_v1.types.SearchUrisResponse:
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([uri, threat_types])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a webrisk.SearchUrisRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, webrisk.SearchUrisRequest):
request = webrisk.SearchUrisRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if uri is not None:
request.uri = uri
if threat_types is not None:
request.threat_types = threat_types
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.search_uris]
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
