Class ScanRun (1.14.0)

Version 1.14.0

• 1.15.1 (latest)
• 1.15.0
• 1.14.5
• 1.13.0
• 1.12.2
• 1.11.1
• 1.10.0
• 1.9.2
• 1.8.3
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.4.2
• 0.3.0

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
Name	Description
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	MutableSequence[google.cloud.websecurityscanner_v1beta.types.ScanRunWarningTrace] A list of warnings, if such are encountered during this scan run.

Classes

ExecutionState

ExecutionState(value)

Types of ScanRun execution state.

Values: EXECUTION_STATE_UNSPECIFIED (0): Represents an invalid state caused by internal server error. This value should never be returned. QUEUED (1): The scan is waiting in the queue. SCANNING (2): The scan is in progress. FINISHED (3): The scan is either finished or stopped by user.

ResultState

ResultState(value)

Types of ScanRun result state.

Values: RESULT_STATE_UNSPECIFIED (0): Default value. This value is returned when the ScanRun is not yet finished. SUCCESS (1): The scan finished without errors. ERROR (2): The scan finished with errors. KILLED (3): The scan was terminated by user.