modulecheck-reporting:sarif/modulecheck.reporting.sarif/Run

Run

@JsonClass(generateAdapter = true)

data class Run( @Json(name = "addresses") val addresses: List<Address>? = null, @Json(name = "artifacts") val artifacts: List<Artifact>? = null, @Json(name = "automationDetails") val automationDetails: RunAutomationDetails? = null, @Json(name = "baselineGuid") val baselineGUID: String? = null, @Json(name = "columnKind") val columnKind: ColumnKind? = null, @Json(name = "conversion") val conversion: Conversion? = null, @Json(name = "defaultEncoding") val defaultEncoding: String? = null, @Json(name = "defaultSourceLanguage") val defaultSourceLanguage: String? = null, @Json(name = "externalPropertyFileReferences") val externalPropertyFileReferences: ExternalPropertyFileReferences? = null, @Json(name = "graphs") val graphs: List<Graph>? = null, @Json(name = "invocations") val invocations: List<Invocation>? = null, @Json(name = "language") val language: String? = null, @Json(name = "logicalLocations") val logicalLocations: List<LogicalLocation>? = null, @Json(name = "newlineSequences") val newlineSequences: List<String>? = null, @Json(name = "originalUriBaseIds") val originalURIBaseIDS: Map<String, ArtifactLocation>? = null, @Json(name = "policies") val policies: List<SarifDriver>? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "redactionTokens") val redactionTokens: List<String>? = null, @Json(name = "results") val results: List<SarifResult>? = null, @Json(name = "runAggregates") val runAggregates: List<RunAutomationDetails>? = null, @Json(name = "specialLocations") val specialLocations: SpecialLocations? = null, @Json(name = "taxonomies") val taxonomies: List<SarifDriver>? = null, @Json(name = "threadFlowLocations") val threadFlowLocations: List<ThreadFlowLocation>? = null, @Json(name = "tool") val tool: Tool, @Json(name = "translations") val translations: List<SarifDriver>? = null, @Json(name = "versionControlProvenance") val versionControlProvenance: List<VersionControlDetails>? = null, @Json(name = "webRequests") val webRequests: List<WebRequest>? = null, @Json(name = "webResponses") val webResponses: List<WebResponse>? = null)

Describes a single run of an analysis tool, and contains the reported output of that run.

Constructors

Run

fun Run( @Json(name = "addresses") addresses: List<Address>? = null, @Json(name = "artifacts") artifacts: List<Artifact>? = null, @Json(name = "automationDetails") automationDetails: RunAutomationDetails? = null, @Json(name = "baselineGuid") baselineGUID: String? = null, @Json(name = "columnKind") columnKind: ColumnKind? = null, @Json(name = "conversion") conversion: Conversion? = null, @Json(name = "defaultEncoding") defaultEncoding: String? = null, @Json(name = "defaultSourceLanguage") defaultSourceLanguage: String? = null, @Json(name = "externalPropertyFileReferences") externalPropertyFileReferences: ExternalPropertyFileReferences? = null, @Json(name = "graphs") graphs: List<Graph>? = null, @Json(name = "invocations") invocations: List<Invocation>? = null, @Json(name = "language") language: String? = null, @Json(name = "logicalLocations") logicalLocations: List<LogicalLocation>? = null, @Json(name = "newlineSequences") newlineSequences: List<String>? = null, @Json(name = "originalUriBaseIds") originalURIBaseIDS: Map<String, ArtifactLocation>? = null, @Json(name = "policies") policies: List<SarifDriver>? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "redactionTokens") redactionTokens: List<String>? = null, @Json(name = "results") results: List<SarifResult>? = null, @Json(name = "runAggregates") runAggregates: List<RunAutomationDetails>? = null, @Json(name = "specialLocations") specialLocations: SpecialLocations? = null, @Json(name = "taxonomies") taxonomies: List<SarifDriver>? = null, @Json(name = "threadFlowLocations") threadFlowLocations: List<ThreadFlowLocation>? = null, @Json(name = "tool") tool: Tool, @Json(name = "translations") translations: List<SarifDriver>? = null, @Json(name = "versionControlProvenance") versionControlProvenance: List<VersionControlDetails>? = null, @Json(name = "webRequests") webRequests: List<WebRequest>? = null, @Json(name = "webResponses") webResponses: List<WebResponse>? = null)

Properties

addresses

val addresses: List<Address>? = null

Addresses associated with this run instance, if any.

artifacts

val artifacts: List<Artifact>? = null

An array of artifact objects relevant to the run.

automationDetails

val automationDetails: RunAutomationDetails? = null

Automation details that describe this run.

baselineGUID

val baselineGUID: String? = null

The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

columnKind

val columnKind: ColumnKind? = null

Specifies the unit in which the tool measures columns.

conversion

val conversion: Conversion? = null

A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.

defaultEncoding

val defaultEncoding: String? = null

Specifies the default encoding for any artifact object that refers to a text file.

defaultSourceLanguage

val defaultSourceLanguage: String? = null

Specifies the default source language for any artifact object that refers to a text file that contains source code.

externalPropertyFileReferences

val externalPropertyFileReferences: ExternalPropertyFileReferences? = null

References to external property files that should be inlined with the content of a root log file.

graphs

val graphs: List<Graph>? = null

An array of zero or more unique graph objects associated with the run.

invocations

val invocations: List<Invocation>? = null

Describes the invocation of the analysis tool.

language

val language: String? = null

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

logicalLocations

val logicalLocations: List<LogicalLocation>? = null

An array of logical locations such as namespaces, types or functions.

newlineSequences

val newlineSequences: List<String>? = null

An ordered list of character sequences that were treated as line breaks when computing region information for the run.

originalURIBaseIDS

val originalURIBaseIDS: Map<String, ArtifactLocation>? = null

The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.

policies

val policies: List<SarifDriver>? = null

Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

properties

val properties: PropertyBag? = null

Key/value pairs that provide additional information about the run.

redactionTokens

val redactionTokens: List<String>? = null

An array of strings used to replace sensitive information in a redaction-aware property.

results

val results: List<SarifResult>? = null

The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

runAggregates

val runAggregates: List<RunAutomationDetails>? = null

Automation details that describe the aggregate of runs to which this run belongs.

specialLocations

val specialLocations: SpecialLocations? = null

A specialLocations object that defines locations of special significance to SARIF consumers.

taxonomies

val taxonomies: List<SarifDriver>? = null

An array of toolComponent objects relevant to a taxonomy in which results are categorized.

threadFlowLocations

val threadFlowLocations: List<ThreadFlowLocation>? = null

An array of threadFlowLocation objects cached at run level.

tool

val tool: Tool

Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

translations

val translations: List<SarifDriver>? = null

The set of available translations of the localized data provided by the tool.

versionControlProvenance

val versionControlProvenance: List<VersionControlDetails>? = null

Specifies the revision in version control of the artifacts that were scanned.

webRequests

val webRequests: List<WebRequest>? = null

An array of request objects cached at run level.

webResponses

val webResponses: List<WebResponse>? = null

An array of response objects cached at run level.

Sources

jvm source