sarif4k/io.github.detekt.sarif4k/Region

Region

@Serializable
data class Region(val byteLength: Long? = null, val byteOffset: Long? = null, val charLength: Long? = null, val charOffset: Long? = null, val endColumn: Long? = null, val endLine: Long? = null, val message: Message? = null, val properties: PropertyBag? = null, val snippet: ArtifactContent? = null, val sourceLanguage: String? = null, val startColumn: Long? = null, val startLine: Long? = null)

A region within an artifact where a result was detected.

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

Specifies a portion of the artifact.

The region of the artifact to delete.

Constructors

Link copied to clipboard
constructor(byteLength: Long? = null, byteOffset: Long? = null, charLength: Long? = null, charOffset: Long? = null, endColumn: Long? = null, endLine: Long? = null, message: Message? = null, properties: PropertyBag? = null, snippet: ArtifactContent? = null, sourceLanguage: String? = null, startColumn: Long? = null, startLine: Long? = null)

Properties

Link copied to clipboard
val byteLength: Long? = null

The length of the region in bytes.

Link copied to clipboard
val byteOffset: Long? = null

The zero-based offset from the beginning of the artifact of the first byte in the region.

Link copied to clipboard
val charLength: Long? = null

The length of the region in characters.

Link copied to clipboard
val charOffset: Long? = null

The zero-based offset from the beginning of the artifact of the first character in the region.

Link copied to clipboard
val endColumn: Long? = null

The column number of the character following the end of the region.

Link copied to clipboard
val endLine: Long? = null

The line number of the last character in the region.

Link copied to clipboard
val message: Message? = null

A message relevant to the region.

Link copied to clipboard
val properties: PropertyBag? = null

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

Link copied to clipboard
val snippet: ArtifactContent? = null

The portion of the artifact contents within the specified region.

Link copied to clipboard
val sourceLanguage: String? = null

Specifies the source language, if any, of the portion of the artifact specified by the region object.

Link copied to clipboard
val startColumn: Long? = null

The column number of the first character in the region.

Link copied to clipboard
val startLine: Long? = null

The line number of the first character in the region.