Google Cloud Web Security Scanner V1beta Client - Class WebSecurityScannerClient (0.7.18)

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ScanConfig;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedParent               The parent resource name where the scan is created, which should be a
 *                                              project resource name in the format 'projects/{projectId}'. Please see
 *                                              {@see WebSecurityScannerClient::projectName()} for help formatting this field.
 * @param string $scanConfigDisplayName         The user provided display name of the ScanConfig.
 * @param string $scanConfigStartingUrlsElement The starting URLs from which the scanner finds site pages.
 */
function create_scan_config_sample(
    string $formattedParent,
    string $scanConfigDisplayName,
    string $scanConfigStartingUrlsElement
): void {
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $scanConfigStartingUrls = [$scanConfigStartingUrlsElement,];
    $scanConfig = (new ScanConfig())
        ->setDisplayName($scanConfigDisplayName)
        ->setStartingUrls($scanConfigStartingUrls);

    // Call the API and handle any network failures.
    try {
        /** @var ScanConfig $response */
        $response = $webSecurityScannerClient->createScanConfig($formattedParent, $scanConfig);
        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 = WebSecurityScannerClient::projectName('[PROJECT]');
    $scanConfigDisplayName = '[DISPLAY_NAME]';
    $scanConfigStartingUrlsElement = '[STARTING_URLS]';

    create_scan_config_sample($formattedParent, $scanConfigDisplayName, $scanConfigStartingUrlsElement);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedName The resource name of the ScanConfig to be deleted. The name follows the
 *                              format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. Please see
 *                              {@see WebSecurityScannerClient::scanConfigName()} for help formatting this field.
 */
function delete_scan_config_sample(string $formattedName): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        $webSecurityScannerClient->deleteScanConfig($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } 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
{
    $formattedName = WebSecurityScannerClient::scanConfigName('[PROJECT]', '[SCAN_CONFIG]');

    delete_scan_config_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\Finding;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedName The resource name of the Finding to be returned. The name follows the
 *                              format of
 *                              'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. Please see
 *                              {@see WebSecurityScannerClient::findingName()} for help formatting this field.
 */
function get_finding_sample(string $formattedName): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var Finding $response */
        $response = $webSecurityScannerClient->getFinding($formattedName);
        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
{
    $formattedName = WebSecurityScannerClient::findingName(
        '[PROJECT]',
        '[SCAN_CONFIG]',
        '[SCAN_RUN]',
        '[FINDING]'
    );

    get_finding_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ScanConfig;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedName The resource name of the ScanConfig to be returned. The name follows the
 *                              format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. Please see
 *                              {@see WebSecurityScannerClient::scanConfigName()} for help formatting this field.
 */
function get_scan_config_sample(string $formattedName): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ScanConfig $response */
        $response = $webSecurityScannerClient->getScanConfig($formattedName);
        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
{
    $formattedName = WebSecurityScannerClient::scanConfigName('[PROJECT]', '[SCAN_CONFIG]');

    get_scan_config_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ScanRun;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedName The resource name of the ScanRun to be returned. The name follows the
 *                              format of
 *                              'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Please see
 *                              {@see WebSecurityScannerClient::scanRunName()} for help formatting this field.
 */
function get_scan_run_sample(string $formattedName): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ScanRun $response */
        $response = $webSecurityScannerClient->getScanRun($formattedName);
        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
{
    $formattedName = WebSecurityScannerClient::scanRunName('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]');

    get_scan_run_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1beta\CrawledUrl;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedParent The parent resource name, which should be a scan run resource name in the
 *                                format
 *                                'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Please see
 *                                {@see WebSecurityScannerClient::scanRunName()} for help formatting this field.
 */
function list_crawled_urls_sample(string $formattedParent): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $webSecurityScannerClient->listCrawledUrls($formattedParent);

        /** @var CrawledUrl $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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 = WebSecurityScannerClient::scanRunName(
        '[PROJECT]',
        '[SCAN_CONFIG]',
        '[SCAN_RUN]'
    );

    list_crawled_urls_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ListFindingTypeStatsResponse;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedParent The parent resource name, which should be a scan run resource name in the
 *                                format
 *                                'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Please see
 *                                {@see WebSecurityScannerClient::scanRunName()} for help formatting this field.
 */
function list_finding_type_stats_sample(string $formattedParent): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ListFindingTypeStatsResponse $response */
        $response = $webSecurityScannerClient->listFindingTypeStats($formattedParent);
        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 = WebSecurityScannerClient::scanRunName(
        '[PROJECT]',
        '[SCAN_CONFIG]',
        '[SCAN_RUN]'
    );

    list_finding_type_stats_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1beta\Finding;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedParent The parent resource name, which should be a scan run resource name in the
 *                                format
 *                                'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Please see
 *                                {@see WebSecurityScannerClient::scanRunName()} for help formatting this field.
 * @param string $filter          The filter expression. The expression must be in the format: <field>
 *                                <operator> <value>.
 *                                Supported field: 'finding_type'.
 *                                Supported operator: '='.
 */
function list_findings_sample(string $formattedParent, string $filter): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $webSecurityScannerClient->listFindings($formattedParent, $filter);

        /** @var Finding $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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 = WebSecurityScannerClient::scanRunName(
        '[PROJECT]',
        '[SCAN_CONFIG]',
        '[SCAN_RUN]'
    );
    $filter = '[FILTER]';

    list_findings_sample($formattedParent, $filter);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1beta\ScanConfig;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedParent The parent resource name, which should be a project resource name in the
 *                                format 'projects/{projectId}'. Please see
 *                                {@see WebSecurityScannerClient::projectName()} for help formatting this field.
 */
function list_scan_configs_sample(string $formattedParent): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $webSecurityScannerClient->listScanConfigs($formattedParent);

        /** @var ScanConfig $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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 = WebSecurityScannerClient::projectName('[PROJECT]');

    list_scan_configs_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1beta\ScanRun;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedParent The parent resource name, which should be a scan resource name in the
 *                                format 'projects/{projectId}/scanConfigs/{scanConfigId}'. Please see
 *                                {@see WebSecurityScannerClient::scanConfigName()} for help formatting this field.
 */
function list_scan_runs_sample(string $formattedParent): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $webSecurityScannerClient->listScanRuns($formattedParent);

        /** @var ScanRun $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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 = WebSecurityScannerClient::scanConfigName('[PROJECT]', '[SCAN_CONFIG]');

    list_scan_runs_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ScanRun;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedName The resource name of the ScanConfig to be used. The name follows the
 *                              format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. Please see
 *                              {@see WebSecurityScannerClient::scanConfigName()} for help formatting this field.
 */
function start_scan_run_sample(string $formattedName): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ScanRun $response */
        $response = $webSecurityScannerClient->startScanRun($formattedName);
        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
{
    $formattedName = WebSecurityScannerClient::scanConfigName('[PROJECT]', '[SCAN_CONFIG]');

    start_scan_run_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ScanRun;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;

/**
 * @param string $formattedName The resource name of the ScanRun to be stopped. The name follows the
 *                              format of
 *                              'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Please see
 *                              {@see WebSecurityScannerClient::scanRunName()} for help formatting this field.
 */
function stop_scan_run_sample(string $formattedName): void
{
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Call the API and handle any network failures.
    try {
        /** @var ScanRun $response */
        $response = $webSecurityScannerClient->stopScanRun($formattedName);
        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
{
    $formattedName = WebSecurityScannerClient::scanRunName('[PROJECT]', '[SCAN_CONFIG]', '[SCAN_RUN]');

    stop_scan_run_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1beta\ScanConfig;
use Google\Cloud\WebSecurityScanner\V1beta\WebSecurityScannerClient;
use Google\Protobuf\FieldMask;

/**
 * @param string $scanConfigDisplayName         The user provided display name of the ScanConfig.
 * @param string $scanConfigStartingUrlsElement The starting URLs from which the scanner finds site pages.
 */
function update_scan_config_sample(
    string $scanConfigDisplayName,
    string $scanConfigStartingUrlsElement
): void {
    // Create a client.
    $webSecurityScannerClient = new WebSecurityScannerClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $scanConfigStartingUrls = [$scanConfigStartingUrlsElement,];
    $scanConfig = (new ScanConfig())
        ->setDisplayName($scanConfigDisplayName)
        ->setStartingUrls($scanConfigStartingUrls);
    $updateMask = new FieldMask();

    // Call the API and handle any network failures.
    try {
        /** @var ScanConfig $response */
        $response = $webSecurityScannerClient->updateScanConfig($scanConfig, $updateMask);
        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
{
    $scanConfigDisplayName = '[DISPLAY_NAME]';
    $scanConfigStartingUrlsElement = '[STARTING_URLS]';

    update_scan_config_sample($scanConfigDisplayName, $scanConfigStartingUrlsElement);
}