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

$webRiskServiceClient = new Google\Cloud\WebRisk\V1\WebRiskServiceClient();
try {
    $threatType = Google\Cloud\WebRisk\V1\ThreatType::THREAT_TYPE_UNSPECIFIED;
    $constraints = new Google\Cloud\WebRisk\V1\ComputeThreatListDiffRequest\Constraints();
    $response = $webRiskServiceClient->computeThreatListDiff($threatType, $constraints);
} finally {
    $webRiskServiceClient->close();
}

Methods

projectName

parseName

getOperationsClient

resumeOperation

__construct

computeThreatListDiff

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

/**
 * @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 any non-scalar elements to be passed along with the request.
    $constraints = new Constraints();

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

/**
 * 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

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

/**
 * @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 any non-scalar elements to be passed along with the request.
    $submission = (new Submission())
        ->setUri($submissionUri);

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

/**
 * 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

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

/**
 * @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 any non-scalar elements to be passed along with the request.
    $threatTypes = [$threatTypesElement,];

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

/**
 * 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

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

/**
 * @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 any non-scalar elements to be passed along with the request.
    $threatTypes = [$threatTypesElement,];

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

/**
 * 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

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\WebRisk\V1\Submission;
use Google\Cloud\WebRisk\V1\WebRiskServiceClient;
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 any non-scalar elements to be passed along with the request.
    $submission = (new Submission())
        ->setUri($submissionUri);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $webRiskServiceClient->submitUri($formattedParent, $submission);
        $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());
    }
}

/**
 * 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);
}

Constants

SERVICE_NAME

Value: 'google.cloud.webrisk.v1.WebRiskService'

SERVICE_ADDRESS

Value: 'webrisk.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'