Class ScanRun (1.7.2)

ScanRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

Attributes

NameDescription
name str
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 google.cloud.websecurityscanner_v1beta.types.ScanRun.ExecutionState
The execution state of the ScanRun.
result_state google.cloud.websecurityscanner_v1beta.types.ScanRun.ResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
start_time google.protobuf.timestamp_pb2.Timestamp
The time at which the ScanRun started.
end_time google.protobuf.timestamp_pb2.Timestamp
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
urls_crawled_count int
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
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
Whether the scan run has found any vulnerabilities.
progress_percent int
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 google.cloud.websecurityscanner_v1beta.types.ScanRunErrorTrace
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 Sequence[google.cloud.websecurityscanner_v1beta.types.ScanRunWarningTrace]
A list of warnings, if such are encountered during this scan run.

Inheritance

builtins.object > proto.message.Message > ScanRun

Classes

ExecutionState

ExecutionState(value)

Types of ScanRun execution state.

ResultState

ResultState(value)

Types of ScanRun result state.