codegurureviewer/aws.sdk.kotlin.services.codegurureviewer.model/RuleMetadata

RuleMetadata

class RuleMetadata

Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

Types

object Companion

Properties

longDescription

val longDescription: String?

A long description of the rule.

val ruleId: String?

The ID of the rule.

val ruleName: String?

The name of the rule.

val ruleTags: List<String>?

Tags that are associated with the rule.

shortDescription

val shortDescription: String?

A short description of the rule.

Functions

inline fun copy(block: RuleMetadata.Builder.() -> Unit = {}): RuleMetadata

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String