Google Cloud Web Security Scanner V1 Client - Class ScanConfig (0.8.5)

Reference documentation and code samples for the Google Cloud Web Security Scanner V1 Client class ScanConfig.

A ScanConfig resource contains the configurations to launch a scan.

Generated from protobuf message google.cloud.websecurityscanner.v1.ScanConfig

Namespace

Google \ Cloud \ WebSecurityScanner \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

↳ display_name string

Required. The user provided display name of the ScanConfig.

↳ max_qps int

The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

↳ starting_urls array

Required. The starting URLs from which the scanner finds site pages.

↳ authentication Google\Cloud\WebSecurityScanner\V1\ScanConfig\Authentication

The authentication configuration. If specified, service will use the authentication configuration during scanning.

↳ user_agent int

The user agent used during scanning.

↳ blacklist_patterns array

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

↳ schedule Google\Cloud\WebSecurityScanner\V1\ScanConfig\Schedule

The schedule of the ScanConfig.

↳ export_to_security_command_center int

Controls export of scan configurations and results to Security Command Center.

↳ risk_level int

The risk level selected for the scan

↳ managed_scan bool

Whether the scan config is managed by Web Security Scanner, output only.

↳ static_ip_scan bool

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

↳ ignore_http_status_errors bool

Whether to keep scanning even if most requests return HTTP error codes.

getName

The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

Returns
Type Description
string

setName

The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The user provided display name of the ScanConfig.

Returns
Type Description
string

setDisplayName

Required. The user provided display name of the ScanConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

getMaxQps

The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

Returns
Type Description
int

setMaxQps

The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

Parameter
Name Description
var int
Returns
Type Description
$this

getStartingUrls

Required. The starting URLs from which the scanner finds site pages.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setStartingUrls

Required. The starting URLs from which the scanner finds site pages.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAuthentication

The authentication configuration. If specified, service will use the authentication configuration during scanning.

Returns
Type Description
Google\Cloud\WebSecurityScanner\V1\ScanConfig\Authentication|null

hasAuthentication

clearAuthentication

setAuthentication

The authentication configuration. If specified, service will use the authentication configuration during scanning.

Parameter
Name Description
var Google\Cloud\WebSecurityScanner\V1\ScanConfig\Authentication
Returns
Type Description
$this

getUserAgent

The user agent used during scanning.

Returns
Type Description
int

setUserAgent

The user agent used during scanning.

Parameter
Name Description
var int
Returns
Type Description
$this

getBlacklistPatterns

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setBlacklistPatterns

Parameter
Name Description
var string[]
Returns
Type Description
$this

getSchedule

The schedule of the ScanConfig.

Returns
Type Description
Google\Cloud\WebSecurityScanner\V1\ScanConfig\Schedule|null

hasSchedule

clearSchedule

setSchedule

The schedule of the ScanConfig.

Parameter
Name Description
var Google\Cloud\WebSecurityScanner\V1\ScanConfig\Schedule
Returns
Type Description
$this

getExportToSecurityCommandCenter

Controls export of scan configurations and results to Security Command Center.

Returns
Type Description
int

setExportToSecurityCommandCenter

Controls export of scan configurations and results to Security Command Center.

Parameter
Name Description
var int
Returns
Type Description
$this

getRiskLevel

The risk level selected for the scan

Returns
Type Description
int

setRiskLevel

The risk level selected for the scan

Parameter
Name Description
var int
Returns
Type Description
$this

getManagedScan

Whether the scan config is managed by Web Security Scanner, output only.

Returns
Type Description
bool

setManagedScan

Whether the scan config is managed by Web Security Scanner, output only.

Parameter
Name Description
var bool
Returns
Type Description
$this

getStaticIpScan

Whether the scan configuration has enabled static IP address scan feature.

If enabled, the scanner will access applications from static IP addresses.

Returns
Type Description
bool

setStaticIpScan

Whether the scan configuration has enabled static IP address scan feature.

If enabled, the scanner will access applications from static IP addresses.

Parameter
Name Description
var bool
Returns
Type Description
$this

getIgnoreHttpStatusErrors

Whether to keep scanning even if most requests return HTTP error codes.

Returns
Type Description
bool

setIgnoreHttpStatusErrors

Whether to keep scanning even if most requests return HTTP error codes.

Parameter
Name Description
var bool
Returns
Type Description
$this