async def test_report_phishing_field_headers_async():
client = PhishingProtectionServiceV1Beta1AsyncClient(
credentials=credentials.AnonymousCredentials(), )
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = phishingprotection.ReportPhishingRequest()
request.parent = "parent/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._client._transport.report_phishing),
"__call__") as call:
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
phishingprotection.ReportPhishingResponse())
await client.report_phishing(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 field header was sent.
_, _, kw = call.mock_calls[0]
assert (
"x-goog-request-params",
"parent=parent/value",
) in kw["metadata"]
async def test_report_phishing_async(transport: str = "grpc_asyncio"):
client = PhishingProtectionServiceV1Beta1AsyncClient(
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 = phishingprotection.ReportPhishingRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._client._transport.report_phishing),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
phishingprotection.ReportPhishingResponse())
response = await client.report_phishing(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, phishingprotection.ReportPhishingResponse)
async def test_report_phishing_flattened_error_async():
client = PhishingProtectionServiceV1Beta1AsyncClient(
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.report_phishing(
phishingprotection.ReportPhishingRequest(),
parent="parent_value",
uri="uri_value",
)
async def report_phishing(
self,
request: phishingprotection.ReportPhishingRequest = None,
*,
parent: str = None,
uri: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> phishingprotection.ReportPhishingResponse:
r"""Reports a URI suspected of containing phishing content to be
reviewed. Once the report review is complete, its result can be
found in the Cloud Security Command Center findings dashboard
for Phishing Protection. If the result verifies the existence of
malicious phishing content, the site will be added the to
`Google's Social Engineering
lists <https://support.google.com/webmasters/answer/6350487/>`__
in order to protect users that could get exposed to this threat
in the future.
Args:
request (:class:`~.phishingprotection.ReportPhishingRequest`):
The request object. The ReportPhishing request message.
parent (:class:`str`):
Required. The name of the project for which the report
will be created, in the format
"projects/{project_number}".
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
uri (:class:`str`):
Required. The URI that is being
reported for phishing content to be
analyzed.
This corresponds to the ``uri`` 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:
~.phishingprotection.ReportPhishingResponse:
The ReportPhishing (empty) response
message.
"""
# 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([parent, uri]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = phishingprotection.ReportPhishingRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if uri is not None:
request.uri = uri
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.report_phishing,
default_timeout=None,
client_info=_client_info,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("parent", request.parent), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response