Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Documentation

data RecommendationSummary

Information about recommendations.

See: newRecommendationSummary smart constructor.

Constructors

RecommendationSummary'

Fields

• description :: Maybe Text

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

• endLine :: Maybe 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 :: Maybe Text

  Name of the file on which a recommendation is provided.

• recommendationCategory :: Maybe RecommendationCategory

  The type of a recommendation.

• recommendationId :: Maybe Text

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

• ruleMetadata :: Maybe 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 :: Maybe Severity

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

• startLine :: Maybe Int

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

Instances

FromJSON RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Methods

parseJSON :: Value -> Parser RecommendationSummary

parseJSONList :: Value -> Parser [RecommendationSummary]

Generic RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Associated Types

type Rep RecommendationSummary :: Type -> Type

Methods

from :: RecommendationSummary -> Rep RecommendationSummary x

to :: Rep RecommendationSummary x -> RecommendationSummary

Read RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Methods

readsPrec :: Int -> ReadS RecommendationSummary

readList :: ReadS [RecommendationSummary]

readPrec :: ReadPrec RecommendationSummary

readListPrec :: ReadPrec [RecommendationSummary]

Show RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Methods

showsPrec :: Int -> RecommendationSummary -> ShowS

show :: RecommendationSummary -> String

showList :: [RecommendationSummary] -> ShowS

NFData RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Methods

rnf :: RecommendationSummary -> ()

Eq RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Methods

(==) :: RecommendationSummary -> RecommendationSummary -> Bool

(/=) :: RecommendationSummary -> RecommendationSummary -> Bool

Hashable RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Methods

hashWithSalt :: Int -> RecommendationSummary -> Int

hash :: RecommendationSummary -> Int

type Rep RecommendationSummary

Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary

type Rep RecommendationSummary = D1 ('MetaData "RecommendationSummary" "Amazonka.CodeGuruReviewer.Types.RecommendationSummary" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "RecommendationSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "filePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recommendationCategory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationCategory)))) :*: ((S1 ('MetaSel ('Just "recommendationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ruleMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleMetadata))) :*: (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Severity)) :*: S1 ('MetaSel ('Just "startLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newRecommendationSummary :: RecommendationSummary

Create a value of RecommendationSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:RecommendationSummary', recommendationSummary_description - A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

$sel:endLine:RecommendationSummary', recommendationSummary_endLine - 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.

$sel:filePath:RecommendationSummary', recommendationSummary_filePath - Name of the file on which a recommendation is provided.

$sel:recommendationCategory:RecommendationSummary', recommendationSummary_recommendationCategory - The type of a recommendation.

$sel:recommendationId:RecommendationSummary', recommendationSummary_recommendationId - The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

$sel:ruleMetadata:RecommendationSummary', recommendationSummary_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.

$sel:severity:RecommendationSummary', recommendationSummary_severity - The severity of the issue in the code that generated this recommendation.

$sel:startLine:RecommendationSummary', recommendationSummary_startLine - Start line from where the recommendation is applicable in the source commit or source branch.

recommendationSummary_description :: Lens' RecommendationSummary (Maybe Text)

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

recommendationSummary_endLine :: Lens' RecommendationSummary (Maybe 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.

recommendationSummary_filePath :: Lens' RecommendationSummary (Maybe Text)

Name of the file on which a recommendation is provided.

recommendationSummary_recommendationCategory :: Lens' RecommendationSummary (Maybe RecommendationCategory)

The type of a recommendation.

recommendationSummary_recommendationId :: Lens' RecommendationSummary (Maybe Text)

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

recommendationSummary_ruleMetadata :: Lens' RecommendationSummary (Maybe 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.

recommendationSummary_severity :: Lens' RecommendationSummary (Maybe Severity)

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

recommendationSummary_startLine :: Lens' RecommendationSummary (Maybe Int)

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