Region

@JsonClass(generateAdapter = true)
data class Region(@Json(name = "byteLength") val byteLength: Int? = null, @Json(name = "byteOffset") val byteOffset: Int? = null, @Json(name = "charLength") val charLength: Int? = null, @Json(name = "charOffset") val charOffset: Int? = null, @Json(name = "endColumn") val endColumn: Int? = null, @Json(name = "endLine") val endLine: Int? = null, @Json(name = "message") val message: Message? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "snippet") val snippet: ArtifactContent? = null, @Json(name = "sourceLanguage") val sourceLanguage: String? = null, @Json(name = "startColumn") val startColumn: Int? = null, @Json(name = "startLine") val startLine: Int? = null)(source)

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.

Since

0.12.0

Constructors

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

Properties

Link copied to clipboard
val byteLength: Int? = null

The length of the region in bytes.

Link copied to clipboard
val byteOffset: Int? = null

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

Link copied to clipboard
val charLength: Int? = null

The length of the region in characters.

Link copied to clipboard
val charOffset: Int? = null

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

Link copied to clipboard
val endColumn: Int? = null

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

Link copied to clipboard
val endLine: Int? = 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

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: Int? = null

The column number of the first character in the region.

Link copied to clipboard
val startLine: Int? = null

The line number of the first character in the region.