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 \ V1Methods
__construct
Constructor.
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
↳ 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.
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.
var
string
$this
getDisplayName
Required. The user provided display name of the ScanConfig.
string
setDisplayName
Required. The user provided display name of the ScanConfig.
var
string
$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.
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.
var
int
$this
getStartingUrls
Required. The starting URLs from which the scanner finds site pages.
setStartingUrls
Required. The starting URLs from which the scanner finds site pages.
var
string[]
$this
getAuthentication
The authentication configuration. If specified, service will use the authentication configuration during scanning.
hasAuthentication
clearAuthentication
setAuthentication
The authentication configuration. If specified, service will use the authentication configuration during scanning.
$this
getUserAgent
The user agent used during scanning.
int
setUserAgent
The user agent used during scanning.
var
int
$this
getBlacklistPatterns
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
setBlacklistPatterns
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
var
string[]
$this
getSchedule
The schedule of the ScanConfig.
hasSchedule
clearSchedule
setSchedule
The schedule of the ScanConfig.
$this
getExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
int
setExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
var
int
$this
getRiskLevel
The risk level selected for the scan
int
setRiskLevel
The risk level selected for the scan
var
int
$this
getManagedScan
Whether the scan config is managed by Web Security Scanner, output only.
bool
setManagedScan
Whether the scan config is managed by Web Security Scanner, output only.
var
bool
$this
getStaticIpScan
Whether the scan configuration has enabled static IP address scan feature.
If enabled, the scanner will access applications from static IP addresses.
bool
setStaticIpScan
Whether the scan configuration has enabled static IP address scan feature.
If enabled, the scanner will access applications from static IP addresses.
var
bool
$this
getIgnoreHttpStatusErrors
Whether to keep scanning even if most requests return HTTP error codes.
bool
setIgnoreHttpStatusErrors
Whether to keep scanning even if most requests return HTTP error codes.
var
bool
$this
