modulecheck-reporting:sarif/modulecheck.reporting.sarif/PhysicalLocation

PhysicalLocation

@JsonClass(generateAdapter = true)
data class PhysicalLocation(@Json(name = "address") val address: Address? = null, @Json(name = "artifactLocation") val artifactLocation: ArtifactLocation? = null, @Json(name = "contextRegion") val contextRegion: Region? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "region") val region: Region? = null)(source)

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.

Since

0.12.0

Constructors

Link copied to clipboard
constructor(@Json(name = "address") address: Address? = null, @Json(name = "artifactLocation") artifactLocation: ArtifactLocation? = null, @Json(name = "contextRegion") contextRegion: Region? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "region") 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.