Google Cloud Web Risk V1 Client - Class WebRiskServiceClient (1.5.4)

Reference documentation and code samples for the Google Cloud Web Risk V1 Client class WebRiskServiceClient.

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ WebRisk \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

computeThreatListDiff

Gets the most recent threat list diffs. These diffs should be applied to a local database of hashes to keep it up-to-date. If the local database is empty or excessively out-of-date, a complete snapshot of the database will be returned. This Method only updates a single ThreatList at a time. To update multiple ThreatList databases, this method needs to be called once for each list.

The async variant is Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient::computeThreatListDiffAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\ComputeThreatListDiffRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\WebRisk\V1\ComputeThreatListDiffResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient;
use Google\Cloud\WebRisk\V1\ComputeThreatListDiffRequest;
use Google\Cloud\WebRisk\V1\ComputeThreatListDiffRequest\Constraints;
use Google\Cloud\WebRisk\V1\ComputeThreatListDiffResponse;
use Google\Cloud\WebRisk\V1\ThreatType;

/**
 * @param int $threatType The threat list to update. Only a single ThreatType should be
 *                        specified per request. If you want to handle multiple ThreatTypes, you must
 *                        make one request per ThreatType.
 */
function compute_threat_list_diff_sample(int $threatType): void
{
    // Create a client.
    $webRiskServiceClient = new WebRiskServiceClient();

    // Prepare the request message.
    $constraints = new Constraints();
    $request = (new ComputeThreatListDiffRequest())
        ->setThreatType($threatType)
        ->setConstraints($constraints);

    // Call the API and handle any network failures.
    try {
        /** @var ComputeThreatListDiffResponse $response */
        $response = $webRiskServiceClient->computeThreatListDiff($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $threatType = ThreatType::THREAT_TYPE_UNSPECIFIED;

    compute_threat_list_diff_sample($threatType);
}

createSubmission

Creates a Submission of a URI suspected of containing phishing content to be reviewed. If the result verifies the existence of malicious phishing content, the site will be added to the Google's Social Engineering lists in order to protect users that could get exposed to this threat in the future. Only allowlisted projects can use this method during Early Access. Please reach out to Sales or your customer engineer to obtain access.

The async variant is Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient::createSubmissionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\CreateSubmissionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\WebRisk\V1\Submission`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient;
use Google\Cloud\WebRisk\V1\CreateSubmissionRequest;
use Google\Cloud\WebRisk\V1\Submission;

/**
 * @param string $formattedParent The name of the project that is making the submission. This
 *                                string is in the format "projects/{project_number}". Please see
 *                                {@see WebRiskServiceClient::projectName()} for help formatting this field.
 * @param string $submissionUri   The URI that is being reported for malicious content to be
 *                                analyzed.
 */
function create_submission_sample(string $formattedParent, string $submissionUri): void
{
    // Create a client.
    $webRiskServiceClient = new WebRiskServiceClient();

    // Prepare the request message.
    $submission = (new Submission())
        ->setUri($submissionUri);
    $request = (new CreateSubmissionRequest())
        ->setParent($formattedParent)
        ->setSubmission($submission);

    // Call the API and handle any network failures.
    try {
        /** @var Submission $response */
        $response = $webRiskServiceClient->createSubmission($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = WebRiskServiceClient::projectName('[PROJECT]');
    $submissionUri = '[URI]';

    create_submission_sample($formattedParent, $submissionUri);
}

searchHashes

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.

The async variant is Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient::searchHashesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\SearchHashesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\WebRisk\V1\SearchHashesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient;
use Google\Cloud\WebRisk\V1\SearchHashesRequest;
use Google\Cloud\WebRisk\V1\SearchHashesResponse;
use Google\Cloud\WebRisk\V1\ThreatType;

/**
 * @param int $threatTypesElement The ThreatLists to search in. Multiple ThreatLists may be
 *                                specified.
 */
function search_hashes_sample(int $threatTypesElement): void
{
    // Create a client.
    $webRiskServiceClient = new WebRiskServiceClient();

    // Prepare the request message.
    $threatTypes = [$threatTypesElement,];
    $request = (new SearchHashesRequest())
        ->setThreatTypes($threatTypes);

    // Call the API and handle any network failures.
    try {
        /** @var SearchHashesResponse $response */
        $response = $webRiskServiceClient->searchHashes($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $threatTypesElement = ThreatType::THREAT_TYPE_UNSPECIFIED;

    search_hashes_sample($threatTypesElement);
}

searchUris

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

Multiple threatLists may be searched in a single query. The response will list all requested threatLists the URI was found to match. If the URI is not found on any of the requested ThreatList an empty response will be returned.

The async variant is Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient::searchUrisAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\SearchUrisRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\WebRisk\V1\SearchUrisResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient;
use Google\Cloud\WebRisk\V1\SearchUrisRequest;
use Google\Cloud\WebRisk\V1\SearchUrisResponse;
use Google\Cloud\WebRisk\V1\ThreatType;

/**
 * @param string $uri                The URI to be checked for matches.
 * @param int    $threatTypesElement The ThreatLists to search in. Multiple ThreatLists may be
 *                                   specified.
 */
function search_uris_sample(string $uri, int $threatTypesElement): void
{
    // Create a client.
    $webRiskServiceClient = new WebRiskServiceClient();

    // Prepare the request message.
    $threatTypes = [$threatTypesElement,];
    $request = (new SearchUrisRequest())
        ->setUri($uri)
        ->setThreatTypes($threatTypes);

    // Call the API and handle any network failures.
    try {
        /** @var SearchUrisResponse $response */
        $response = $webRiskServiceClient->searchUris($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $uri = '[URI]';
    $threatTypesElement = ThreatType::THREAT_TYPE_UNSPECIFIED;

    search_uris_sample($uri, $threatTypesElement);
}

submitUri

Submits a URI suspected of containing malicious content to be reviewed.

Returns a google.longrunning.Operation which, once the review is complete, is updated with its result. You can use the Pub/Sub API to receive notifications for the returned Operation. If the result verifies the existence of malicious content, the site will be added to the Google's Social Engineering lists in order to protect users that could get exposed to this threat in the future. Only allowlisted projects can use this method during Early Access. Please reach out to Sales or your customer engineer to obtain access.

The async variant is Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient::submitUriAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\SubmitUriRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\WebRisk\V1\Client\WebRiskServiceClient;
use Google\Cloud\WebRisk\V1\Submission;
use Google\Cloud\WebRisk\V1\SubmitUriRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The name of the project that is making the submission. This
 *                                string is in the format "projects/{project_number}". Please see
 *                                {@see WebRiskServiceClient::projectName()} for help formatting this field.
 * @param string $submissionUri   The URI that is being reported for malicious content to be
 *                                analyzed.
 */
function submit_uri_sample(string $formattedParent, string $submissionUri): void
{
    // Create a client.
    $webRiskServiceClient = new WebRiskServiceClient();

    // Prepare the request message.
    $submission = (new Submission())
        ->setUri($submissionUri);
    $request = (new SubmitUriRequest())
        ->setParent($formattedParent)
        ->setSubmission($submission);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $webRiskServiceClient->submitUri($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Submission $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = WebRiskServiceClient::projectName('[PROJECT]');
    $submissionUri = '[URI]';

    submit_uri_sample($formattedParent, $submissionUri);
}

computeThreatListDiffAsync

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\ComputeThreatListDiffRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createSubmissionAsync

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\CreateSubmissionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

searchHashesAsync

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\SearchHashesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

searchUrisAsync

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\SearchUrisRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

submitUriAsync

Parameters
Name	Description
`request`	`Google\Cloud\WebRisk\V1\SubmitUriRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

project: projects/{project}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.