sarif/com.jetbrains.qodana.sarif.model/Notification

Notification

open class Notification : PropertyOwner

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

Constructors

Notification

constructor()

No args constructor for use in serialization

constructor(message: Message)

Types

Level

enum Level

A value specifying the severity level of the notification.

Properties

associatedRule

@SerializedName(value = "associatedRule")

@Expose

open var associatedRule: ReportingDescriptorReference

Information about how to locate a relevant reporting descriptor.

descriptor

@SerializedName(value = "descriptor")

@Expose

open var descriptor: ReportingDescriptorReference

Information about how to locate a relevant reporting descriptor.

exception

@SerializedName(value = "exception")

@Expose

open var exception: Exception

Describes a runtime exception encountered during the execution of an analysis tool.

level

@SerializedName(value = "level")

@Expose

open var level: Notification.Level

A value specifying the severity level of the notification.

locations

@SerializedName(value = "locations")

@Expose

open var locations: Set<Location>

The locations relevant to this notification.

message

@SerializedName(value = "message")

@Expose

open var message: Message

Encapsulates a message intended to be read by the end user.

properties

@SerializedName(value = "properties")

@Expose

open var properties: PropertyBag

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

threadId

@SerializedName(value = "threadId")

@Expose

open var threadId: Integer

The thread identifier of the code that generated the notification.

timeUtc

@SerializedName(value = "timeUtc")

@Expose

open var timeUtc: Instant

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

Functions

equals

open fun equals(other: Any): Boolean

getProperties

abstract fun getProperties(): PropertyBag

hashCode

open fun hashCode(): Int

setProperties

abstract fun setProperties(<set-?>: PropertyBag)

toString

open fun toString(): String

updateProperties

open fun updateProperties(mutator: (in PropertyBag) -> Unit)

withAssociatedRule

open fun withAssociatedRule(associatedRule: ReportingDescriptorReference): Notification

withDescriptor

open fun withDescriptor(descriptor: ReportingDescriptorReference): Notification

withException

open fun withException(exception: Exception): Notification

withLevel

open fun withLevel(level: Notification.Level): Notification

withLocations

open fun withLocations(locations: Set<Location>): Notification

withMessage

open fun withMessage(message: Message): Notification

withProperties

open fun withProperties(properties: PropertyBag): Notification

withThreadId

open fun withThreadId(threadId: Integer): Notification

withTimeUtc

open fun withTimeUtc(timeUtc: Instant): Notification