Class WebRiskServiceV1Beta1Client (1.13.0)

WebRiskServiceV1Beta1Client(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.webrisk_v1beta1.services.web_risk_service_v1_beta1.transports.base.WebRiskServiceV1Beta1Transport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`WebRiskServiceV1Beta1Transport`	The transport used by the client instance.

Methods

WebRiskServiceV1Beta1Client

WebRiskServiceV1Beta1Client(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.webrisk_v1beta1.services.web_risk_service_v1_beta1.transports.base.WebRiskServiceV1Beta1Transport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates 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`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` 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_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

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

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

compute_threat_list_diff

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

Gets the most recent threat list diffs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import webrisk_v1beta1

def sample_compute_threat_list_diff():
    # Create a client
    client = webrisk_v1beta1.WebRiskServiceV1Beta1Client()

    # Initialize request argument(s)
    request = webrisk_v1beta1.ComputeThreatListDiffRequest(
        threat_type="UNWANTED_SOFTWARE",
    )

    # Make the request
    response = client.compute_threat_list_diff(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.webrisk_v1beta1.types.ComputeThreatListDiffRequest, dict]` The request object. Describes an API diff request.
`threat_type`	`google.cloud.webrisk_v1beta1.types.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`	`google.cloud.webrisk_v1beta1.types.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
`WebRiskServiceV1Beta1Client`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`WebRiskServiceV1Beta1Client`	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
`WebRiskServiceV1Beta1Client`	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

search_hashes

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

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import webrisk_v1beta1

def sample_search_hashes():
    # Create a client
    client = webrisk_v1beta1.WebRiskServiceV1Beta1Client()

    # Initialize request argument(s)
    request = webrisk_v1beta1.SearchHashesRequest(
        threat_types=['UNWANTED_SOFTWARE'],
    )

    # Make the request
    response = client.search_hashes(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.webrisk_v1beta1.types.SearchHashesRequest, dict]` 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`	`MutableSequence[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.

search_uris

search_uris(
    request: typing.Optional[
        typing.Union[google.cloud.webrisk_v1beta1.types.webrisk.SearchUrisRequest, dict]
    ] = None,
    *,
    uri: typing.Optional[str] = None,
    threat_types: typing.Optional[
        typing.MutableSequence[google.cloud.webrisk_v1beta1.types.webrisk.ThreatType]
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.webrisk_v1beta1.types.webrisk.SearchUrisResponse

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import webrisk_v1beta1

def sample_search_uris():
    # Create a client
    client = webrisk_v1beta1.WebRiskServiceV1Beta1Client()

    # Initialize request argument(s)
    request = webrisk_v1beta1.SearchUrisRequest(
        uri="uri_value",
        threat_types=['UNWANTED_SOFTWARE'],
    )

    # Make the request
    response = client.search_uris(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.webrisk_v1beta1.types.SearchUrisRequest, dict]` 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`	`MutableSequence[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.