BuildScan

Contains scan results, including findings, for a particular build.

JSON representation
{
  "requestTime": string,
  "completionTime": string,
  "status": enum (Status),
  "actionableFindings": [
    {
      object (Finding)
    }
  ],
  "findingSummary": {
    object (FindingsSummary)
  }
}
Fields
requestTime

string (Timestamp format)

Time at which this scan was requested.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

completionTime

string (Timestamp format)

Time at which this scan was completed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

status

enum (Status)

actionableFindings[]

object (Finding)

All findings that have a Finding.Result of RESULT_WARNING or RESULT_ALERT.

findingSummary

object (FindingsSummary)

FindingsSummary for external findings.

Status

Enums
UNKNOWN
ANALYZING
COMPLETED
FAILED
CANCELLED Status CANCELLED is set when some new BuildScan is initiated.

Finding

Contains information about a single finding.

JSON representation
{
  "findingId": string,
  "result": enum (PolicyResult),
  "ruleId": string,
  "description": string
}
Fields
findingId

string

Unique id for this finding. The string does not necessarily carry semantic meaning.

result

enum (PolicyResult)

ruleId

string

Id of the generic rule that generated this finding.

description

string

Description of the finding along with guidance on how to resolve it.

PolicyResult

Enums
RESULT_UNSPECIFIED
RESULT_INFO
RESULT_WARNING
RESULT_ALERT
RESULT_OK
RESULT_ERROR
RESULT_PENDING

FindingsSummary

FindingsSummary tallies how many findings are of each result in a single build scan.

JSON representation
{
  "findingsNumInfo": string,
  "findingsNumWarning": string,
  "findingsNumAlert": string,
  "findingsNumOk": string,
  "findingsNumError": string,
  "findingsNumPending": string
}
Fields
findingsNumInfo

string (int64 format)

findingsNumWarning

string (int64 format)

findingsNumAlert

string (int64 format)

findingsNumOk

string (int64 format)

findingsNumError

string (int64 format)

findingsNumPending

string (int64 format)