sarif/com.jetbrains.qodana.sarif.model/Result

Result

open class Result : PropertyOwner

A result produced by an analysis tool.

Constructors

Result

constructor()

No args constructor for use in serialization

constructor(message: Message)

Types

BaselineState

enum BaselineState

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

Kind

enum Kind

A value that categorizes results by evaluation state.

Properties

analysisTarget

@SerializedName(value = "analysisTarget")

@Expose

open var analysisTarget: ArtifactLocation

Specifies the location of an artifact.

attachments

@SerializedName(value = "attachments")

@Expose

open var attachments: Set<Attachment>

A set of artifacts relevant to the result.

baselineState

@SerializedName(value = "baselineState")

@Expose

open var baselineState: Result.BaselineState

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

codeFlows

@SerializedName(value = "codeFlows")

@Expose

open var codeFlows: List<CodeFlow>

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

correlationGuid

@SerializedName(value = "correlationGuid")

@Expose

open var correlationGuid: String

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

fingerprints

@SerializedName(value = "fingerprints")

@Expose

open var fingerprints: VersionedMap<String>

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

fixes

@SerializedName(value = "fixes")

@Expose

open var fixes: Set<Fix>

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

graphs

@SerializedName(value = "graphs")

@Expose

open var graphs: Set<Graph>

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

graphTraversals

@SerializedName(value = "graphTraversals")

@Expose

open var graphTraversals: Set<GraphTraversal>

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

guid

@SerializedName(value = "guid")

@Expose

open var guid: String

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

hostedViewerUri

@SerializedName(value = "hostedViewerUri")

@Expose

open var hostedViewerUri: URI

An absolute URI at which the result can be viewed.

kind

@SerializedName(value = "kind")

@Expose

open var kind: Result.Kind

A value that categorizes results by evaluation state.

level

@SerializedName(value = "level")

@Expose

open var level: Level

A value specifying the severity level of the result.

locations

@SerializedName(value = "locations")

@Expose

open var locations: List<Location>

The set of locations where the result was detected.

message

@SerializedName(value = "message")

@Expose

open var message: Message

Encapsulates a message intended to be read by the end user.

occurrenceCount

@SerializedName(value = "occurrenceCount")

@Expose

open var occurrenceCount: Integer

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

partialFingerprints

@SerializedName(value = "partialFingerprints")

@Expose

open var partialFingerprints: VersionedMap<String>

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

properties

@SerializedName(value = "properties")

@Expose

open var properties: PropertyBag

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

provenance

@SerializedName(value = "provenance")

@Expose

open var provenance: ResultProvenance

Contains information about how and when a result was detected.

rank

@SerializedName(value = "rank")

@Expose

open var rank: Double

A number representing the priority or importance of the result.

relatedLocations

@SerializedName(value = "relatedLocations")

@Expose

open var relatedLocations: Set<Location>

A set of locations relevant to this result.

rule

@SerializedName(value = "rule")

@Expose

open var rule: ReportingDescriptorReference

Information about how to locate a relevant reporting descriptor.

ruleId

@SerializedName(value = "ruleId")

@Expose

open var ruleId: String

The stable, unique identifier of the rule, if any, to which this result is relevant.

ruleIndex

@SerializedName(value = "ruleIndex")

@Expose

open var ruleIndex: Integer

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

stacks

@SerializedName(value = "stacks")

@Expose

open var stacks: Set<Stack>

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

suppressions

@SerializedName(value = "suppressions")

@Expose

open var suppressions: Set<Suppression>

A set of suppressions relevant to this result.

taxa

@SerializedName(value = "taxa")

@Expose

open var taxa: Set<ReportingDescriptorReference>

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

webRequest

@SerializedName(value = "webRequest")

@Expose

open var webRequest: WebRequest

Describes an HTTP request.

webResponse

@SerializedName(value = "webResponse")

@Expose

open var webResponse: WebResponse

Describes the response to an HTTP request.

workItemUris

@SerializedName(value = "workItemUris")

@Expose

open var workItemUris: Set<URI>

The URIs of the work items associated with this result.

Functions

equals

open fun equals(other: Any): Boolean

getProperties

abstract fun getProperties(): PropertyBag

hashCode

open fun hashCode(): Int

setProperties

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

toString

open fun toString(): String

updateProperties

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

withAnalysisTarget

open fun withAnalysisTarget(analysisTarget: ArtifactLocation): Result

withAttachments

open fun withAttachments(attachments: Set<Attachment>): Result

withBaselineState

open fun withBaselineState(baselineState: Result.BaselineState): Result

withCodeFlows

open fun withCodeFlows(codeFlows: List<CodeFlow>): Result

withCorrelationGuid

open fun withCorrelationGuid(correlationGuid: String): Result

withFingerprints

open fun withFingerprints(fingerprints: VersionedMap<String>): Result

withFixes

open fun withFixes(fixes: Set<Fix>): Result

withGraphs

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

withGraphTraversals

open fun withGraphTraversals(graphTraversals: Set<GraphTraversal>): Result

withGuid

open fun withGuid(guid: String): Result

withHostedViewerUri

open fun withHostedViewerUri(hostedViewerUri: URI): Result

withKind

open fun withKind(kind: Result.Kind): Result

withLevel

open fun withLevel(level: Level): Result

withLocations

open fun withLocations(locations: List<Location>): Result

withMessage

open fun withMessage(message: Message): Result

withOccurrenceCount

open fun withOccurrenceCount(occurrenceCount: Integer): Result

withPartialFingerprints

open fun withPartialFingerprints(partialFingerprints: VersionedMap<String>): Result

withProperties

open fun withProperties(properties: PropertyBag): Result

withProvenance

open fun withProvenance(provenance: ResultProvenance): Result

withRank

open fun withRank(rank: Double): Result

withRelatedLocations

open fun withRelatedLocations(relatedLocations: Set<Location>): Result

withRule

open fun withRule(rule: ReportingDescriptorReference): Result

withRuleId

open fun withRuleId(ruleId: String): Result

withRuleIndex

open fun withRuleIndex(ruleIndex: Integer): Result

withStacks

open fun withStacks(stacks: Set<Stack>): Result

withSuppressions

open fun withSuppressions(suppressions: Set<Suppression>): Result

withTaxa

open fun withTaxa(taxa: Set<ReportingDescriptorReference>): Result

withWebRequest

open fun withWebRequest(webRequest: WebRequest): Result

withWebResponse

open fun withWebResponse(webResponse: WebResponse): Result

withWorkItemUris

open fun withWorkItemUris(workItemUris: Set<URI>): Result