sarif/com.jetbrains.qodana.sarif.model/Run

Run

open class Run : PropertyOwner

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

Constructors

constructor()

No args constructor for use in serialization

constructor(tool: Tool)

Types

enum ColumnKind

Specifies the unit in which the tool measures columns.

Properties

@SerializedName(value = "addresses")

@Expose

open var addresses: List<Address>

Addresses associated with this run instance, if any.

@SerializedName(value = "artifacts")

@Expose

open var artifacts: Set<Artifact>

An array of artifact objects relevant to the run.

automationDetails

@SerializedName(value = "automationDetails")

@Expose

open var automationDetails: RunAutomationDetails

Information that describes a run's identity and role within an engineering system process.

@SerializedName(value = "baselineGuid")

@Expose

open var baselineGuid: String

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

@SerializedName(value = "columnKind")

@Expose

open var columnKind: Run.ColumnKind

Specifies the unit in which the tool measures columns.

@SerializedName(value = "conversion")

@Expose

open var conversion: Conversion

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

defaultEncoding

@SerializedName(value = "defaultEncoding")

@Expose

open var defaultEncoding: String

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

defaultSourceLanguage

@SerializedName(value = "defaultSourceLanguage")

@Expose

open var defaultSourceLanguage: String

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

externalPropertyFileReferences

@SerializedName(value = "externalPropertyFileReferences")

@Expose

open var externalPropertyFileReferences: ExternalPropertyFileReferences

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

@SerializedName(value = "graphs")

@Expose

open var graphs: Set<Graph>

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

@SerializedName(value = "invocations")

@Expose

open var invocations: List<Invocation>

Describes the invocation of the analysis tool.

@SerializedName(value = "language")

@Expose

open var language: String

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).

logicalLocations

@SerializedName(value = "logicalLocations")

@Expose

open var logicalLocations: Set<LogicalLocation>

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

newlineSequences

@SerializedName(value = "newlineSequences")

@Expose

open var newlineSequences: Set<String>

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

originalUriBaseIds

@SerializedName(value = "originalUriBaseIds")

@Expose

open var originalUriBaseIds: OriginalUriBaseIds

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

@SerializedName(value = "policies")

@Expose

open var policies: Set<ToolComponent>

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).

@SerializedName(value = "properties")

@Expose

open var properties: PropertyBag

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

redactionTokens

@SerializedName(value = "redactionTokens")

@Expose

open var redactionTokens: Set<String>

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

@SerializedName(value = "results")

@Expose

open var results: List<Result>

The set of results contained in an SARIF log.

@SerializedName(value = "runAggregates")

@Expose

open var runAggregates: Set<RunAutomationDetails>

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

specialLocations

@SerializedName(value = "specialLocations")

@Expose

open var specialLocations: SpecialLocations

Defines locations of special significance to SARIF consumers.

@SerializedName(value = "taxonomies")

@Expose

open var taxonomies: Set<ToolComponent>

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

threadFlowLocations

@SerializedName(value = "threadFlowLocations")

@Expose

open var threadFlowLocations: Set<ThreadFlowLocation>

An array of threadFlowLocation objects cached at run level.

@SerializedName(value = "tool")

@Expose

open var tool: Tool

The analysis tool that was run.

@SerializedName(value = "translations")

@Expose

open var translations: Set<ToolComponent>

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

versionControlProvenance

@SerializedName(value = "versionControlProvenance")

@Expose

open var versionControlProvenance: Set<VersionControlDetails>

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

@SerializedName(value = "webRequests")

@Expose

open var webRequests: Set<WebRequest>

An array of request objects cached at run level.

@SerializedName(value = "webResponses")

@Expose

open var webResponses: Set<WebResponse>

An array of response objects cached at run level.

Functions

open fun equals(other: Any): Boolean

abstract fun getProperties(): PropertyBag

open fun hashCode(): Int

abstract fun setProperties(<set-?>: PropertyBag)

open fun toString(): String

updateProperties

open fun updateProperties(mutator: (in PropertyBag) -> Unit)

open fun withAddresses(addresses: List<Address>): Run

open fun withArtifacts(artifacts: Set<Artifact>): Run

withAutomationDetails

open fun withAutomationDetails(automationDetails: RunAutomationDetails): Run

withBaselineGuid

open fun withBaselineGuid(baselineGuid: String): Run

open fun withColumnKind(columnKind: Run.ColumnKind): Run

open fun withConversion(conversion: Conversion): Run

withDefaultEncoding

open fun withDefaultEncoding(defaultEncoding: String): Run

withDefaultSourceLanguage

open fun withDefaultSourceLanguage(defaultSourceLanguage: String): Run

withExternalPropertyFileReferences

open fun withExternalPropertyFileReferences(externalPropertyFileReferences: ExternalPropertyFileReferences): Run

open fun withGraphs(graphs: Set<Graph>): Run

withInvocations

open fun withInvocations(invocations: List<Invocation>): Run

open fun withLanguage(language: String): Run

withLogicalLocations

open fun withLogicalLocations(logicalLocations: Set<LogicalLocation>): Run

withNewlineSequences

open fun withNewlineSequences(newlineSequences: Set<String>): Run

withOriginalUriBaseIds

open fun withOriginalUriBaseIds(originalUriBaseIds: OriginalUriBaseIds): Run

open fun withPolicies(policies: Set<ToolComponent>): Run

open fun withProperties(properties: PropertyBag): Run

withRedactionTokens

open fun withRedactionTokens(redactionTokens: Set<String>): Run

open fun withResults(results: List<Result>): Run

withRunAggregates

open fun withRunAggregates(runAggregates: Set<RunAutomationDetails>): Run

withSpecialLocations

open fun withSpecialLocations(specialLocations: SpecialLocations): Run

open fun withTaxonomies(taxonomies: Set<ToolComponent>): Run

withThreadFlowLocations

open fun withThreadFlowLocations(threadFlowLocations: Set<ThreadFlowLocation>): Run

open fun withTool(tool: Tool): Run

withTranslations

open fun withTranslations(translations: Set<ToolComponent>): Run

withVersionControlProvenance

open fun withVersionControlProvenance(versionControlProvenance: Set<VersionControlDetails>): Run

withWebRequests

open fun withWebRequests(webRequests: Set<WebRequest>): Run

withWebResponses

open fun withWebResponses(webResponses: Set<WebResponse>): Run