modulecheck-reporting:sarif/modulecheck.reporting.sarif/MultiformatMessageString

MultiformatMessageString

@JsonClass(generateAdapter = true)

data class MultiformatMessageString(@Json(name = "markdown") val markdown: String? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "text") val text: String)(source)

An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).

A message string or message format string rendered in multiple formats.

A comprehensive description of the tool component.

A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

Provides the primary documentation for the report, useful when there is no online documentation.

A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.

A brief description of the tool component.

A comprehensive description of the translation metadata.

A brief description of the translation metadata.

Since

0.12.0

Constructors

MultiformatMessageString

constructor(@Json(name = "markdown") markdown: String? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "text") text: String)

Properties

markdown

val markdown: String? = null

A Markdown message string or format string.

properties

val properties: PropertyBag? = null

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

text

val text: String

A plain text message string or format string.