modulecheck-reporting:sarif/modulecheck.reporting.sarif/SarifResult

SarifResult

@JsonClass(generateAdapter = true)

data class SarifResult(@Json(name = "analysisTarget") val analysisTarget: ArtifactLocation? = null, @Json(name = "attachments") val attachments: List<Attachment>? = null, @Json(name = "baselineState") val baselineState: BaselineState? = null, @Json(name = "codeFlows") val codeFlows: List<CodeFlow>? = null, @Json(name = "correlationGuid") val correlationGUID: String? = null, @Json(name = "fingerprints") val fingerprints: Map<String, String>? = null, @Json(name = "fixes") val fixes: List<Fix>? = null, @Json(name = "graphs") val graphs: List<Graph>? = null, @Json(name = "graphTraversals") val graphTraversals: List<GraphTraversal>? = null, @Json(name = "guid") val guid: String? = null, @Json(name = "hostedViewerUri") val hostedViewerURI: String? = null, @Json(name = "kind") val kind: ResultKind? = null, @Json(name = "level") val level: Level? = null, @Json(name = "locations") val locations: List<Location>? = null, @Json(name = "message") val message: Message, @Json(name = "occurrenceCount") val occurrenceCount: Int? = null, @Json(name = "partialFingerprints") val partialFingerprints: Map<String, String>? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "provenance") val provenance: ResultProvenance? = null, @Json(name = "rank") val rank: Double? = null, @Json(name = "relatedLocations") val relatedLocations: List<Location>? = null, @Json(name = "rule") val rule: ReportingDescriptorReference? = null, @Json(name = "ruleId") val ruleID: String? = null, @Json(name = "ruleIndex") val ruleIndex: Int? = null, @Json(name = "stacks") val stacks: List<Stack>? = null, @Json(name = "suppressions") val suppressions: List<Suppression>? = null, @Json(name = "taxa") val taxa: List<ReportingDescriptorReference>? = null, @Json(name = "webRequest") val webRequest: WebRequest? = null, @Json(name = "webResponse") val webResponse: WebResponse? = null, @Json(name = "workItemUris") val workItemUris: List<String>? = null)(source)

A result produced by an analysis tool.

Since

0.12.0

Constructors

SarifResult

constructor(@Json(name = "analysisTarget") analysisTarget: ArtifactLocation? = null, @Json(name = "attachments") attachments: List<Attachment>? = null, @Json(name = "baselineState") baselineState: BaselineState? = null, @Json(name = "codeFlows") codeFlows: List<CodeFlow>? = null, @Json(name = "correlationGuid") correlationGUID: String? = null, @Json(name = "fingerprints") fingerprints: Map<String, String>? = null, @Json(name = "fixes") fixes: List<Fix>? = null, @Json(name = "graphs") graphs: List<Graph>? = null, @Json(name = "graphTraversals") graphTraversals: List<GraphTraversal>? = null, @Json(name = "guid") guid: String? = null, @Json(name = "hostedViewerUri") hostedViewerURI: String? = null, @Json(name = "kind") kind: ResultKind? = null, @Json(name = "level") level: Level? = null, @Json(name = "locations") locations: List<Location>? = null, @Json(name = "message") message: Message, @Json(name = "occurrenceCount") occurrenceCount: Int? = null, @Json(name = "partialFingerprints") partialFingerprints: Map<String, String>? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "provenance") provenance: ResultProvenance? = null, @Json(name = "rank") rank: Double? = null, @Json(name = "relatedLocations") relatedLocations: List<Location>? = null, @Json(name = "rule") rule: ReportingDescriptorReference? = null, @Json(name = "ruleId") ruleID: String? = null, @Json(name = "ruleIndex") ruleIndex: Int? = null, @Json(name = "stacks") stacks: List<Stack>? = null, @Json(name = "suppressions") suppressions: List<Suppression>? = null, @Json(name = "taxa") taxa: List<ReportingDescriptorReference>? = null, @Json(name = "webRequest") webRequest: WebRequest? = null, @Json(name = "webResponse") webResponse: WebResponse? = null, @Json(name = "workItemUris") workItemUris: List<String>? = null)

Properties

analysisTarget

val analysisTarget: ArtifactLocation? = null

Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.

attachments

val attachments: List<Attachment>? = null

A set of artifacts relevant to the result.

baselineState

val baselineState: BaselineState? = null

The state of a result relative to a baseline of a previous run.

codeFlows

val codeFlows: List<CodeFlow>? = null

An array of 'codeFlow' objects relevant to the result.

correlationGUID

val correlationGUID: String? = null

A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

fingerprints

val fingerprints: Map<String, String>? = null

A set of strings each of which individually defines a stable, unique identity for the result.

fixes

val fixes: List<Fix>? = null

An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

graphs

val graphs: List<Graph>? = null

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

graphTraversals

val graphTraversals: List<GraphTraversal>? = null

An array of one or more unique 'graphTraversal' objects.

guid

val guid: String? = null

A stable, unique identifer for the result in the form of a GUID.

hostedViewerURI

val hostedViewerURI: String? = null

An absolute URI at which the result can be viewed.

kind

val kind: ResultKind? = null

A value that categorizes results by evaluation state.

level

val level: Level? = null

A value specifying the severity level of the result.

locations

val locations: List<Location>? = null

The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

message

val message: Message

A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

occurrenceCount

val occurrenceCount: Int? = null

A positive integer specifying the number of times this logically unique result was observed in this run.

partialFingerprints

val partialFingerprints: Map<String, String>? = null

A set of strings that contribute to the stable, unique identity of the result.

properties

val properties: PropertyBag? = null

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

provenance

val provenance: ResultProvenance? = null

Information about how and when the result was detected.

rank

val rank: Double? = null

A number representing the priority or importance of the result.

relatedLocations

val relatedLocations: List<Location>? = null

A set of locations relevant to this result.

rule

val rule: ReportingDescriptorReference? = null

A reference used to locate the rule descriptor relevant to this result.

ruleID

val ruleID: String? = null

The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.

ruleIndex

val ruleIndex: Int? = null

The index within the tool component rules array of the rule object associated with this result.

stacks

val stacks: List<Stack>? = null

An array of 'stack' objects relevant to the result.

suppressions

val suppressions: List<Suppression>? = null

A set of suppressions relevant to this result.

taxa

val taxa: List<ReportingDescriptorReference>? = null

An array of references to taxonomy reporting descriptors that are applicable to the result.