modulecheck-reporting:sarif/modulecheck.reporting.sarif/ReportingDescriptorReference

ReportingDescriptorReference

@JsonClass(generateAdapter = true)

data class ReportingDescriptorReference(@Json(name = "guid") val guid: String? = null, @Json(name = "id") val id: String? = null, @Json(name = "index") val index: Int? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "toolComponent") val toolComponent: ToolComponentReference? = null)(source)

A reference used to locate the descriptor whose configuration was overridden.

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

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

A reference to the related reporting descriptor.

A reference used to locate the rule descriptor relevant to this result.

Information about how to locate a relevant reporting descriptor.

Since

0.12.0

Constructors

ReportingDescriptorReference

constructor(@Json(name = "guid") guid: String? = null, @Json(name = "id") id: String? = null, @Json(name = "index") index: Int? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "toolComponent") toolComponent: ToolComponentReference? = null)

Properties

guid

val guid: String? = null

A guid that uniquely identifies the descriptor.

val id: String? = null

The id of the descriptor.

index

val index: Int? = null

The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

properties

val properties: PropertyBag? = null

Key/value pairs that provide additional information about the reporting descriptor reference.

toolComponent

val toolComponent: ToolComponentReference? = null

A reference used to locate the toolComponent associated with the descriptor.