Class WebRiskServiceV1Beta1Client (1.0.1)

Version 1.0.1

• 1.15.1 (latest)
• 1.15.0
• 1.14.5
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.0
• 1.8.4
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.1
• 0.3.3
• 0.2.0

WebRiskServiceV1Beta1Client(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.webrisk_v1beta1.services.web_risk_service_v1_beta1.transports.base.WebRiskServiceV1Beta1Transport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-webrisk/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.

Methods

WebRiskServiceV1Beta1Client

WebRiskServiceV1Beta1Client(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.webrisk_v1beta1.services.web_risk_service_v1_beta1.transports.base.WebRiskServiceV1Beta1Transport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-webrisk/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate the web risk 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, .WebRiskServiceV1Beta1Transport] 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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

compute_threat_list_diff

compute_threat_list_diff(request: Optional[google.cloud.webrisk_v1beta1.types.webrisk.ComputeThreatListDiffRequest] = None, *, threat_type: Optional[google.cloud.webrisk_v1beta1.types.webrisk.ThreatType] = None, version_token: Optional[bytes] = None, constraints: Optional[google.cloud.webrisk_v1beta1.types.webrisk.ComputeThreatListDiffRequest.Constraints] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the most recent threat list diffs.

Parameters
Name	Description
request	.webrisk.ComputeThreatListDiffRequest The request object. Describes an API diff request.
threat_type	.webrisk.ThreatType The ThreatList to update. This corresponds to the threat_type field on the request instance; if request is provided, this should not be set.
version_token	bytes The current version token of the client for the requested list (the client version that was received from the last successful diff). This corresponds to the version_token field on the request instance; if request is provided, this should not be set.
constraints	.webrisk.ComputeThreatListDiffRequest.Constraints Required. The constraints associated with this request. This corresponds to the constraints 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.

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.

search_hashes

search_hashes(request: Optional[google.cloud.webrisk_v1beta1.types.webrisk.SearchHashesRequest] = None, *, hash_prefix: Optional[bytes] = None, threat_types: Optional[Sequence[google.cloud.webrisk_v1beta1.types.webrisk.ThreatType]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
request	.webrisk.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	:class:Sequence[.webrisk.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.

search_uris

search_uris(request: Optional[google.cloud.webrisk_v1beta1.types.webrisk.SearchUrisRequest] = None, *, uri: Optional[str] = None, threat_types: Optional[Sequence[google.cloud.webrisk_v1beta1.types.webrisk.ThreatType]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

This method is used to check whether a URI is on a given threatList.

Parameters
Name	Description
request	.webrisk.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	:class:Sequence[.webrisk.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.