sarif4k/io.github.detekt.sarif4k/PhysicalLocation

PhysicalLocation

@Serializable
data class PhysicalLocation(val address: Address? = null, val artifactLocation: ArtifactLocation? = null, val contextRegion: Region? = null, val properties: PropertyBag? = null, val region: Region? = null)

Identifies the artifact and region.

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Constructors

Link copied to clipboard
constructor(address: Address? = null, artifactLocation: ArtifactLocation? = null, contextRegion: Region? = null, properties: PropertyBag? = null, region: Region? = null)

Properties

Link copied to clipboard
val address: Address? = null

The address of the location.

Link copied to clipboard
val artifactLocation: ArtifactLocation? = null

The location of the artifact.

Link copied to clipboard
val contextRegion: Region? = null

Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.

Link copied to clipboard
val properties: PropertyBag? = null

Key/value pairs that provide additional information about the physical location.

Link copied to clipboard
val region: Region? = null

Specifies a portion of the artifact.