Reference documentation and code samples for the Google Cloud Web Security Scanner V1beta Client class ScanConfig.
A ScanConfig resource contains the configurations to launch a scan.
Generated from protobuf message google.cloud.websecurityscanner.v1beta.ScanConfig
Namespace
Google \ Cloud \ WebSecurityScanner \ V1betaMethods
__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\V1beta\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 blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
↳ schedule
↳ target_platforms
array
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
↳ export_to_security_command_center
int
Controls export of scan configurations and results to Cloud Security Command Center.
↳ latest_run
↳ risk_level
int
The risk level selected for the scan
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 blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
setBlacklistPatterns
The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
var
string[]
$this
getSchedule
The schedule of the ScanConfig.
hasSchedule
clearSchedule
setSchedule
The schedule of the ScanConfig.
$this
getTargetPlatforms
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
setTargetPlatforms
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
var
int[]
$this
getExportToSecurityCommandCenter
Controls export of scan configurations and results to Cloud Security Command Center.
int
setExportToSecurityCommandCenter
Controls export of scan configurations and results to Cloud Security Command Center.
var
int
$this
getLatestRun
Latest ScanRun if available.
hasLatestRun
clearLatestRun
setLatestRun
Latest ScanRun if available.
$this
getRiskLevel
The risk level selected for the scan
int
setRiskLevel
The risk level selected for the scan
var
int
$this
