Reference documentation and code samples for the Google Cloud Web Security Scanner V1 Client class ScanRun.
A ScanRun is a output-only resource representing an actual run of the scan.
Next id: 12
Generated from protobuf message google.cloud.websecurityscanner.v1.ScanRun
Namespace
Google \ Cloud \ WebSecurityScanner \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
↳ execution_state
int
Output only. The execution state of the ScanRun.
↳ result_state
int
Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
↳ start_time
↳ end_time
Google\Protobuf\Timestamp
Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
↳ urls_crawled_count
int|string
Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
↳ urls_tested_count
int|string
Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
↳ has_vulnerabilities
bool
Output only. Whether the scan run has found any vulnerabilities.
↳ progress_percent
int
Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
↳ error_trace
ScanRunErrorTrace
Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
↳ warning_traces
array< ScanRunWarningTrace
>
Output only. A list of warnings, if such are encountered during this scan run.
getName
Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
The ScanRun IDs are generated by the system.
string
setName
Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
The ScanRun IDs are generated by the system.
var
string
$this
getExecutionState
Output only. The execution state of the ScanRun.
int
setExecutionState
Output only. The execution state of the ScanRun.
var
int
$this
getResultState
Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
int
setResultState
Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
var
int
$this
getStartTime
Output only. The time at which the ScanRun started.
hasStartTime
clearStartTime
setStartTime
Output only. The time at which the ScanRun started.
$this
getEndTime
Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
hasEndTime
clearEndTime
setEndTime
Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
$this
getUrlsCrawledCount
Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
int|string
setUrlsCrawledCount
Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
var
int|string
$this
getUrlsTestedCount
Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
int|string
setUrlsTestedCount
Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
var
int|string
$this
getHasVulnerabilities
Output only. Whether the scan run has found any vulnerabilities.
bool
setHasVulnerabilities
Output only. Whether the scan run has found any vulnerabilities.
var
bool
$this
getProgressPercent
Output only. The percentage of total completion ranging from 0 to 100.
If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
int
setProgressPercent
Output only. The percentage of total completion ranging from 0 to 100.
If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
var
int
$this
getErrorTrace
Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
hasErrorTrace
clearErrorTrace
setErrorTrace
Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
$this
getWarningTraces
Output only. A list of warnings, if such are encountered during this scan run.
setWarningTraces
Output only. A list of warnings, if such are encountered during this scan run.
$this
