Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeGuruReviewer.Types.RecommendationSummary

Description

Synopsis

data RecommendationSummary = RecommendationSummary' {
- recommendationId :: Maybe Text
- filePath :: Maybe Text
- severity :: Maybe Severity
- ruleMetadata :: Maybe RuleMetadata
- startLine :: Maybe Int
- endLine :: Maybe Int
- description :: Maybe Text
- recommendationCategory :: Maybe RecommendationCategory
}
newRecommendationSummary :: RecommendationSummary
recommendationSummary_recommendationId :: Lens' RecommendationSummary (Maybe Text)
recommendationSummary_filePath :: Lens' RecommendationSummary (Maybe Text)
recommendationSummary_severity :: Lens' RecommendationSummary (Maybe Severity)
recommendationSummary_ruleMetadata :: Lens' RecommendationSummary (Maybe RuleMetadata)
recommendationSummary_startLine :: Lens' RecommendationSummary (Maybe Int)
recommendationSummary_endLine :: Lens' RecommendationSummary (Maybe Int)
recommendationSummary_description :: Lens' RecommendationSummary (Maybe Text)
recommendationSummary_recommendationCategory :: Lens' RecommendationSummary (Maybe RecommendationCategory)

Documentation

data RecommendationSummary Source #

Information about recommendations.

See: newRecommendationSummary smart constructor.

Constructors

RecommendationSummary'

Fields

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.
filePath :: Maybe Text
Name of the file on which a recommendation is provided.
severity :: Maybe Severity
The severity of the issue in the code that generated this recommendation.
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.
startLine :: Maybe Int
Start line from where the recommendation is applicable in the source commit or source branch.
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.
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.
recommendationCategory :: Maybe RecommendationCategory
The type of a recommendation.

Instances

Instances details

Eq RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Methods (==) :: RecommendationSummary -> RecommendationSummary -> Bool # (/=) :: RecommendationSummary -> RecommendationSummary -> Bool #
Read RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Methods readsPrec :: Int -> ReadS RecommendationSummary # readList :: ReadS [RecommendationSummary] # readPrec :: ReadPrec RecommendationSummary # readListPrec :: ReadPrec [RecommendationSummary] #
Show RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Methods showsPrec :: Int -> RecommendationSummary -> ShowS # show :: RecommendationSummary -> String # showList :: [RecommendationSummary] -> ShowS #
Generic RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Associated Types type Rep RecommendationSummary :: Type -> Type # Methods from :: RecommendationSummary -> Rep RecommendationSummary x # to :: Rep RecommendationSummary x -> RecommendationSummary #
NFData RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Methods rnf :: RecommendationSummary -> () #
Hashable RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Methods hashWithSalt :: Int -> RecommendationSummary -> Int # hash :: RecommendationSummary -> Int #
FromJSON RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary Methods parseJSON :: Value -> Parser RecommendationSummary # parseJSONList :: Value -> Parser [RecommendationSummary] #
type Rep RecommendationSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RecommendationSummary type Rep RecommendationSummary = D1 ('MetaData "RecommendationSummary" "Amazonka.CodeGuruReviewer.Types.RecommendationSummary" "libZSservicesZSamazonka-codeguru-reviewerZSamazonka-codeguru-reviewer" 'False) (C1 ('MetaCons "RecommendationSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "recommendationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Severity)) :: S1 ('MetaSel ('Just "ruleMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleMetadata)))) :: ((S1 ('MetaSel ('Just "startLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "endLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recommendationCategory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationCategory))))))

newRecommendationSummary :: RecommendationSummary Source #

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: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:filePath:RecommendationSummary', recommendationSummary_filePath - Name of the file on which a recommendation is provided.

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

$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:startLine:RecommendationSummary', recommendationSummary_startLine - Start line from where the recommendation is applicable in the source commit or source branch.

$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: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:recommendationCategory:RecommendationSummary', recommendationSummary_recommendationCategory - The type of a recommendation.

recommendationSummary_recommendationId :: Lens' RecommendationSummary (Maybe Text) Source #

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

recommendationSummary_filePath :: Lens' RecommendationSummary (Maybe Text) Source #

Name of the file on which a recommendation is provided.

recommendationSummary_severity :: Lens' RecommendationSummary (Maybe Severity) Source #

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

recommendationSummary_ruleMetadata :: Lens' RecommendationSummary (Maybe RuleMetadata) Source #

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_startLine :: Lens' RecommendationSummary (Maybe Int) Source #

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

recommendationSummary_endLine :: Lens' RecommendationSummary (Maybe Int) Source #

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_description :: Lens' RecommendationSummary (Maybe Text) Source #

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

recommendationSummary_recommendationCategory :: Lens' RecommendationSummary (Maybe RecommendationCategory) Source #

The type of a recommendation.