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

RecommendationSummary

class RecommendationSummary

Information about recommendations.

Types

Builder

class Builder

Companion

object Companion

Properties

description

val description: String?

A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

endLine

val endLine: Int?

Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

filePath

val filePath: String?

Name of the file on which a recommendation is provided.

recommendationCategory

val recommendationCategory: RecommendationCategory?

The type of a recommendation.

recommendationId

val recommendationId: String?

The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

ruleMetadata

val ruleMetadata: 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.

severity

val severity: Severity?

The severity of the issue in the code that generated this recommendation.

startLine

val startLine: Int?

Start line from where the recommendation is applicable in the source commit or source branch.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String