sarif/com.jetbrains.qodana.sarif.model/ReportingDescriptor

ReportingDescriptor

open class ReportingDescriptor : PropertyOwner

Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

Constructors

ReportingDescriptor

constructor()

No args constructor for use in serialization

constructor(id: String)

Properties

defaultConfiguration

@SerializedName(value = "defaultConfiguration")

@Expose

open var defaultConfiguration: ReportingConfiguration

Information about a rule or notification that can be configured at runtime.

deprecatedGuids

@SerializedName(value = "deprecatedGuids")

@Expose

open var deprecatedGuids: Set<String>

An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

deprecatedIds

@SerializedName(value = "deprecatedIds")

@Expose

open var deprecatedIds: Set<String>

An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

deprecatedNames

@SerializedName(value = "deprecatedNames")

@Expose

open var deprecatedNames: Set<String>

An array of readable identifiers by which this report was known in some previous version of the analysis tool.

fullDescription

@SerializedName(value = "fullDescription")

@Expose

open var fullDescription: MultiformatMessageString

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

guid

@SerializedName(value = "guid")

@Expose

open var guid: String

A unique identifer for the reporting descriptor in the form of a GUID.

help

@SerializedName(value = "help")

@Expose

open var help: MultiformatMessageString

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

helpUri

@SerializedName(value = "helpUri")

@Expose

open var helpUri: URI

A URI where the primary documentation for the report can be found.

@SerializedName(value = "id")

@Expose

open var id: String

A stable, opaque identifier for the report.

messageStrings

@SerializedName(value = "messageStrings")

@Expose

open var messageStrings: MessageStrings

A set of name/value pairs with arbitrary names.

name

@SerializedName(value = "name")

@Expose

open var name: String

A report identifier that is understandable to an end user.

properties

@SerializedName(value = "properties")

@Expose

open var properties: PropertyBag

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

relationships

@SerializedName(value = "relationships")

@Expose

open var relationships: Set<ReportingDescriptorRelationship>

An array of objects that describe relationships between this reporting descriptor and others.

shortDescription

@SerializedName(value = "shortDescription")

@Expose

open var shortDescription: MultiformatMessageString

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

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)

withDefaultConfiguration

open fun withDefaultConfiguration(defaultConfiguration: ReportingConfiguration): ReportingDescriptor

withDeprecatedGuids

open fun withDeprecatedGuids(deprecatedGuids: Set<String>): ReportingDescriptor

withDeprecatedIds

open fun withDeprecatedIds(deprecatedIds: Set<String>): ReportingDescriptor

withDeprecatedNames

open fun withDeprecatedNames(deprecatedNames: Set<String>): ReportingDescriptor

withFullDescription

open fun withFullDescription(fullDescription: MultiformatMessageString): ReportingDescriptor

withGuid

open fun withGuid(guid: String): ReportingDescriptor

withHelp

open fun withHelp(help: MultiformatMessageString): ReportingDescriptor

withHelpUri

open fun withHelpUri(helpUri: URI): ReportingDescriptor

withId

open fun withId(id: String): ReportingDescriptor

withMessageStrings

open fun withMessageStrings(messageStrings: MessageStrings): ReportingDescriptor

withName

open fun withName(name: String): ReportingDescriptor

withProperties

open fun withProperties(properties: PropertyBag): ReportingDescriptor

withRelationships

open fun withRelationships(relationships: Set<ReportingDescriptorRelationship>): ReportingDescriptor

withShortDescription

open fun withShortDescription(shortDescription: MultiformatMessageString): ReportingDescriptor