Class ScanRun
A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Implements
Inherited Members
Namespace: Google.Apis.WebSecurityScanner.v1beta.Data
Assembly: Google.Apis.WebSecurityScanner.v1beta.dll
Syntax
public class ScanRun : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndTime
object representation of EndTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type | Description |
---|---|
object |
EndTimeDateTimeOffset
DateTimeOffset representation of EndTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
EndTimeRaw
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
ErrorTrace
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
Declaration
[JsonProperty("errorTrace")]
public virtual ScanRunErrorTrace ErrorTrace { get; set; }
Property Value
Type | Description |
---|---|
ScanRunErrorTrace |
ExecutionState
The execution state of the ScanRun.
Declaration
[JsonProperty("executionState")]
public virtual string ExecutionState { get; set; }
Property Value
Type | Description |
---|---|
string |
HasVulnerabilities
Whether the scan run has found any vulnerabilities.
Declaration
[JsonProperty("hasVulnerabilities")]
public virtual bool? HasVulnerabilities { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
ProgressPercent
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.
Declaration
[JsonProperty("progressPercent")]
public virtual int? ProgressPercent { get; set; }
Property Value
Type | Description |
---|---|
int? |
ResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
Declaration
[JsonProperty("resultState")]
public virtual string ResultState { get; set; }
Property Value
Type | Description |
---|---|
string |
StartTime
object representation of StartTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
StartTimeDateTimeOffset
DateTimeOffset representation of StartTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
StartTimeRaw
The time at which the ScanRun started.
Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
UrlsCrawledCount
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.
Declaration
[JsonProperty("urlsCrawledCount")]
public virtual long? UrlsCrawledCount { get; set; }
Property Value
Type | Description |
---|---|
long? |
UrlsTestedCount
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.
Declaration
[JsonProperty("urlsTestedCount")]
public virtual long? UrlsTestedCount { get; set; }
Property Value
Type | Description |
---|---|
long? |
WarningTraces
A list of warnings, if such are encountered during this scan run.
Declaration
[JsonProperty("warningTraces")]
public virtual IList<ScanRunWarningTrace> WarningTraces { get; set; }
Property Value
Type | Description |
---|---|
IList<ScanRunWarningTrace> |