Reference documentation and code samples for the Google Cloud Web Security Scanner V1 Client class WebSecurityScannerClient.
Service Description: Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ WebSecurityScanner \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
createScanConfig
Creates a new ScanConfig.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::createScanConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\CreateScanConfigRequest
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\WebSecurityScanner\V1\ScanConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\CreateScanConfigRequest;
use Google\Cloud\WebSecurityScanner\V1\ScanConfig;
/**
* 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 create_scan_config_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new CreateScanConfigRequest();
// Call the API and handle any network failures.
try {
/** @var ScanConfig $response */
$response = $webSecurityScannerClient->createScanConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
deleteScanConfig
Deletes an existing ScanConfig and its child resources.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::deleteScanConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\DeleteScanConfigRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\DeleteScanConfigRequest;
/**
* 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 delete_scan_config_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new DeleteScanConfigRequest();
// Call the API and handle any network failures.
try {
$webSecurityScannerClient->deleteScanConfig($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getFinding
Gets a Finding.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::getFindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\GetFindingRequest
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\WebSecurityScanner\V1\Finding |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\Finding;
use Google\Cloud\WebSecurityScanner\V1\GetFindingRequest;
/**
* 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 get_finding_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new GetFindingRequest();
// Call the API and handle any network failures.
try {
/** @var Finding $response */
$response = $webSecurityScannerClient->getFinding($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getScanConfig
Gets a ScanConfig.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::getScanConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\GetScanConfigRequest
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\WebSecurityScanner\V1\ScanConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\GetScanConfigRequest;
use Google\Cloud\WebSecurityScanner\V1\ScanConfig;
/**
* 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 get_scan_config_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new GetScanConfigRequest();
// Call the API and handle any network failures.
try {
/** @var ScanConfig $response */
$response = $webSecurityScannerClient->getScanConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getScanRun
Gets a ScanRun.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::getScanRunAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\GetScanRunRequest
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\WebSecurityScanner\V1\ScanRun |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\GetScanRunRequest;
use Google\Cloud\WebSecurityScanner\V1\ScanRun;
/**
* 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 get_scan_run_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new GetScanRunRequest();
// Call the API and handle any network failures.
try {
/** @var ScanRun $response */
$response = $webSecurityScannerClient->getScanRun($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listCrawledUrls
List CrawledUrls under a given ScanRun.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::listCrawledUrlsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListCrawledUrlsRequest
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\CrawledUrl;
use Google\Cloud\WebSecurityScanner\V1\ListCrawledUrlsRequest;
/**
* 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 list_crawled_urls_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new ListCrawledUrlsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $webSecurityScannerClient->listCrawledUrls($request);
/** @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());
}
}
listFindingTypeStats
List all FindingTypeStats under a given ScanRun.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::listFindingTypeStatsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListFindingTypeStatsRequest
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\WebSecurityScanner\V1\ListFindingTypeStatsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\ListFindingTypeStatsRequest;
use Google\Cloud\WebSecurityScanner\V1\ListFindingTypeStatsResponse;
/**
* 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 list_finding_type_stats_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new ListFindingTypeStatsRequest();
// Call the API and handle any network failures.
try {
/** @var ListFindingTypeStatsResponse $response */
$response = $webSecurityScannerClient->listFindingTypeStats($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listFindings
List Findings under a given ScanRun.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::listFindingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListFindingsRequest
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\Finding;
use Google\Cloud\WebSecurityScanner\V1\ListFindingsRequest;
/**
* 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 list_findings_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new ListFindingsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $webSecurityScannerClient->listFindings($request);
/** @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());
}
}
listScanConfigs
Lists ScanConfigs under a given project.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::listScanConfigsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListScanConfigsRequest
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\ListScanConfigsRequest;
use Google\Cloud\WebSecurityScanner\V1\ScanConfig;
/**
* 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 list_scan_configs_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new ListScanConfigsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $webSecurityScannerClient->listScanConfigs($request);
/** @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());
}
}
listScanRuns
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::listScanRunsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListScanRunsRequest
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\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\ListScanRunsRequest;
use Google\Cloud\WebSecurityScanner\V1\ScanRun;
/**
* 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 list_scan_runs_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new ListScanRunsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $webSecurityScannerClient->listScanRuns($request);
/** @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());
}
}
startScanRun
Start a ScanRun according to the given ScanConfig.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::startScanRunAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\StartScanRunRequest
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\WebSecurityScanner\V1\ScanRun |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\ScanRun;
use Google\Cloud\WebSecurityScanner\V1\StartScanRunRequest;
/**
* 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 start_scan_run_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new StartScanRunRequest();
// Call the API and handle any network failures.
try {
/** @var ScanRun $response */
$response = $webSecurityScannerClient->startScanRun($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
stopScanRun
Stops a ScanRun. The stopped ScanRun is returned.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::stopScanRunAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\StopScanRunRequest
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\WebSecurityScanner\V1\ScanRun |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\ScanRun;
use Google\Cloud\WebSecurityScanner\V1\StopScanRunRequest;
/**
* 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 stop_scan_run_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new StopScanRunRequest();
// Call the API and handle any network failures.
try {
/** @var ScanRun $response */
$response = $webSecurityScannerClient->stopScanRun($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateScanConfig
Updates a ScanConfig. This method support partial update of a ScanConfig.
The async variant is Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient::updateScanConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\UpdateScanConfigRequest
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\WebSecurityScanner\V1\ScanConfig |
use Google\ApiCore\ApiException;
use Google\Cloud\WebSecurityScanner\V1\Client\WebSecurityScannerClient;
use Google\Cloud\WebSecurityScanner\V1\ScanConfig;
use Google\Cloud\WebSecurityScanner\V1\UpdateScanConfigRequest;
/**
* 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 update_scan_config_sample(): void
{
// Create a client.
$webSecurityScannerClient = new WebSecurityScannerClient();
// Prepare the request message.
$request = new UpdateScanConfigRequest();
// Call the API and handle any network failures.
try {
/** @var ScanConfig $response */
$response = $webSecurityScannerClient->updateScanConfig($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createScanConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\CreateScanConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteScanConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\DeleteScanConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getFindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\GetFindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getScanConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\GetScanConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getScanRunAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\GetScanRunRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listCrawledUrlsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListCrawledUrlsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFindingTypeStatsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListFindingTypeStatsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFindingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListFindingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listScanConfigsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListScanConfigsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listScanRunsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\ListScanRunsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
startScanRunAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\StartScanRunRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
stopScanRunAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\StopScanRunRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateScanConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\WebSecurityScanner\V1\UpdateScanConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |