PhishingProtectionServiceV1Beta1AsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.phishingprotection_v1beta1.services.phishing_protection_service_v1_beta1.transports.base.PhishingProtectionServiceV1Beta1Transport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-phishingprotection/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Service to report phishing URIs.
Properties
transport
Return the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
PhishingProtectionServiceV1Beta1Transport | The transport used by the client instance. |
Methods
PhishingProtectionServiceV1Beta1AsyncClient
PhishingProtectionServiceV1Beta1AsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.phishingprotection_v1beta1.services.phishing_protection_service_v1_beta1.transports.base.PhishingProtectionServiceV1Beta1Transport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-phishingprotection/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiate the phishing protection service v1 beta1 client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)Return a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
{@api.name} | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
{@api.name} | The constructed client. |
get_transport_class
get_transport_class()Return an appropriate transport class.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
report_phishing
report_phishing(request: Optional[google.cloud.phishingprotection_v1beta1.types.phishingprotection.ReportPhishingRequest] = None, *, parent: Optional[str] = None, uri: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. The ReportPhishing request message. |
parent |
Required. The name of the project for which the report will be created, in the format "projects/{project_number}". This corresponds to the |
uri |
Required. The URI that is being reported for phishing content to be analyzed. This corresponds to the |
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 | |
|---|---|
| Type | Description |
| The ReportPhishing (empty) response message. |