ScanRun

import type { ScanRun } from "https://googleapis.deno.dev/v1/websecurityscanner:v1.ts";

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

interface ScanRun {

endTime?: Date;

errorTrace?: ScanRunErrorTrace;

executionState?:

| "EXECUTION_STATE_UNSPECIFIED"

| "QUEUED"

| "SCANNING"

| "FINISHED";

hasVulnerabilities?: boolean;

name?: string;

progressPercent?: number;

resultState?:

| "RESULT_STATE_UNSPECIFIED"

| "SUCCESS"

| "ERROR"

| "KILLED";

startTime?: Date;

urlsCrawledCount?: bigint;

urlsTestedCount?: bigint;

warningTraces?: ScanRunWarningTrace[];

}

§Properties

endTime?: Date

[src]

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

errorTrace?: ScanRunErrorTrace

[src]

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.

executionState?: "EXECUTION_STATE_UNSPECIFIED" | "QUEUED" | "SCANNING" | "FINISHED"

[src]

Output only. The execution state of the ScanRun.

hasVulnerabilities?: boolean

[src]

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

name?: string

[src]

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.

progressPercent?: number

[src]

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.

resultState?: "RESULT_STATE_UNSPECIFIED" | "SUCCESS" | "ERROR" | "KILLED"

[src]

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

startTime?: Date

[src]

Output only. The time at which the ScanRun started.

urlsCrawledCount?: bigint

[src]

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.

urlsTestedCount?: bigint

[src]

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.

warningTraces?: ScanRunWarningTrace[]

[src]

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