Web Security Scanner v1 API - Class ScanRun (2.1.0)

public sealed class ScanRun : IMessage<ScanRun>, IEquatable<ScanRun>, IDeepCloneable<ScanRun>, IBufferMessage, IMessage

Reference documentation and code samples for the Web Security Scanner v1 API class ScanRun.

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

Inheritance

Object > ScanRun

Implements

IMessage<ScanRun>, IEquatable<ScanRun>, IDeepCloneable<ScanRun>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.WebSecurityScanner.V1

Assembly

Google.Cloud.WebSecurityScanner.V1.dll

Constructors

ScanRun()

public ScanRun()

ScanRun(ScanRun)

public ScanRun(ScanRun other)

Parameter
Name	Description
`other`	`ScanRun`

Properties

EndTime

public Timestamp EndTime { get; set; }

Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

Property Value
Type	Description
`Timestamp`

ErrorTrace

public ScanRunErrorTrace ErrorTrace { get; set; }

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.

Property Value
Type	Description
`ScanRunErrorTrace`

ExecutionState

public ScanRun.Types.ExecutionState ExecutionState { get; set; }

Output only. The execution state of the ScanRun.

Property Value
Type	Description
`ScanRun.Types.ExecutionState`

HasVulnerabilities

public bool HasVulnerabilities { get; set; }

Output only. Whether the scan run has found any vulnerabilities.

Property Value
Type	Description
`Boolean`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`String`

ProgressPercent

public int ProgressPercent { get; set; }

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.

Property Value
Type	Description
`Int32`

ResultState

public ScanRun.Types.ResultState ResultState { get; set; }

Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

Property Value
Type	Description
`ScanRun.Types.ResultState`

StartTime

public Timestamp StartTime { get; set; }

Output only. The time at which the ScanRun started.

Property Value
Type	Description
`Timestamp`

UrlsCrawledCount

public long UrlsCrawledCount { get; set; }

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.

Property Value
Type	Description
`Int64`

UrlsTestedCount

public long UrlsTestedCount { get; set; }

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.

Property Value
Type	Description
`Int64`

WarningTraces

public RepeatedField<ScanRunWarningTrace> WarningTraces { get; }

Output only. A list of warnings, if such are encountered during this scan run.

Property Value
Type	Description
`RepeatedField<ScanRunWarningTrace>`