sarif4k/io.github.detekt.sarif4k/Notification

Notification

@Serializable

data class Notification(val associatedRule: ReportingDescriptorReference? = null, val descriptor: ReportingDescriptorReference? = null, val exception: Exception? = null, val level: Level? = null, val locations: List<Location>? = null, val message: Message, val properties: PropertyBag? = null, val threadID: Long? = null, val timeUTC: String? = null)

Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

Constructors

constructor(associatedRule: ReportingDescriptorReference? = null, descriptor: ReportingDescriptorReference? = null, exception: Exception? = null, level: Level? = null, locations: List<Location>? = null, message: Message, properties: PropertyBag? = null, threadID: Long? = null, timeUTC: String? = null)

Properties

val associatedRule: ReportingDescriptorReference? = null

A reference used to locate the rule descriptor associated with this notification.

val descriptor: ReportingDescriptorReference? = null

A reference used to locate the descriptor relevant to this notification.

val exception: Exception? = null

The runtime exception, if any, relevant to this notification.

val level: Level? = null

A value specifying the severity level of the notification.

val locations: List<Location>? = null

The locations relevant to this notification.

val message: Message

A message that describes the condition that was encountered.

val properties: PropertyBag? = null

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

val threadID: Long? = null

The thread identifier of the code that generated the notification.

val timeUTC: String? = null

The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.