async def test_search_hashes_async(transport: str = "grpc_asyncio"):
client = WebRiskServiceV1Beta1AsyncClient(
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.SearchHashesRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._client._transport.search_hashes),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
webrisk.SearchHashesResponse())
response = await client.search_hashes(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.SearchHashesResponse)
async def test_search_hashes_flattened_error_async():
client = WebRiskServiceV1Beta1AsyncClient(
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_hashes(
webrisk.SearchHashesRequest(),
hash_prefix=b"hash_prefix_blob",
threat_types=[webrisk.ThreatType.MALWARE],
)
async def search_hashes(
self,
request: webrisk.SearchHashesRequest = None,
*,
hash_prefix: bytes = None,
threat_types: Sequence[webrisk.ThreatType] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> webrisk.SearchHashesResponse:
r"""Gets the full hashes that match the requested hash
prefix. This is used after a hash prefix is looked up in
a threatList and there is a match. The client side
threatList only holds partial hashes so the client must
query this method to determine if there is a full hash
match of a threat.
Args:
request (:class:`google.cloud.webrisk_v1beta1.types.SearchHashesRequest`):
The request object. Request to return full hashes
matched by the provided hash prefixes.
hash_prefix (:class:`bytes`):
A hash prefix, consisting of the most
significant 4-32 bytes of a SHA256 hash.
For JSON requests, this field is
base64-encoded.
This corresponds to the ``hash_prefix`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
threat_types (:class:`Sequence[google.cloud.webrisk_v1beta1.types.ThreatType]`):
Required. The ThreatLists to search
in.
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_v1beta1.types.SearchHashesResponse:
"""
# 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([hash_prefix, 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.")
request = webrisk.SearchHashesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if hash_prefix is not None:
request.hash_prefix = hash_prefix
if threat_types:
request.threat_types.extend(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_hashes,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.ServiceUnavailable,
),
deadline=600.0,
),
default_timeout=600.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def search_hashes(
self,
request: webrisk.SearchHashesRequest = None,
*,
hash_prefix: bytes = None,
threat_types: Sequence[webrisk.ThreatType] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> webrisk.SearchHashesResponse:
r"""Gets the full hashes that match the requested hash
prefix. This is used after a hash prefix is looked up in
a threatList and there is a match. The client side
threatList only holds partial hashes so the client must
query this method to determine if there is a full hash
match of a threat.
Args:
request (google.cloud.webrisk_v1beta1.types.SearchHashesRequest):
The request object. Request to return full hashes
matched by the provided hash prefixes.
hash_prefix (bytes):
A hash prefix, consisting of the most
significant 4-32 bytes of a SHA256 hash.
For JSON requests, this field is
base64-encoded.
This corresponds to the ``hash_prefix`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
threat_types (Sequence[google.cloud.webrisk_v1beta1.types.ThreatType]):
Required. The ThreatLists to search
in.
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_v1beta1.types.SearchHashesResponse:
"""
# 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([hash_prefix, 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.SearchHashesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, webrisk.SearchHashesRequest):
request = webrisk.SearchHashesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if hash_prefix is not None:
request.hash_prefix = hash_prefix
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_hashes]
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
