Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeGuruReviewer.Types.Metrics

Description

Synopsis

Documentation

data Metrics Source #

Information about the statistics from the code review.

See: newMetrics smart constructor.

Constructors

Metrics'

Fields

findingsCount :: Maybe Integer
Total number of recommendations found in the code review.
meteredLinesOfCodeCount :: Maybe Integer
MeteredLinesOfCodeCount is the number of lines of code in the repository where the code review happened. This does not include non-code lines such as comments and blank lines.
suppressedLinesOfCodeCount :: Maybe Integer
SuppressedLinesOfCodeCount is the number of lines of code in the repository where the code review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the excludeFiles variable in the aws-codeguru-reviewer.yml file. This number does not include non-code lines such as comments and blank lines.

Instances

Instances details

FromJSON Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Methods parseJSON :: Value -> Parser Metrics # parseJSONList :: Value -> Parser [Metrics] #
Generic Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Associated Types type Rep Metrics :: Type -> Type # Methods from :: Metrics -> Rep Metrics x # to :: Rep Metrics x -> Metrics #
Read Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Methods readsPrec :: Int -> ReadS Metrics # readList :: ReadS [Metrics] # readPrec :: ReadPrec Metrics # readListPrec :: ReadPrec [Metrics] #
Show Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Methods showsPrec :: Int -> Metrics -> ShowS # show :: Metrics -> String # showList :: [Metrics] -> ShowS #
NFData Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Methods rnf :: Metrics -> () #
Eq Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Methods (==) :: Metrics -> Metrics -> Bool # (/=) :: Metrics -> Metrics -> Bool #
Hashable Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics Methods hashWithSalt :: Int -> Metrics -> Int # hash :: Metrics -> Int #
type Rep Metrics Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.Metrics type Rep Metrics = D1 ('MetaData "Metrics" "Amazonka.CodeGuruReviewer.Types.Metrics" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "Metrics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "findingsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "meteredLinesOfCodeCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "suppressedLinesOfCodeCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newMetrics :: Metrics Source #

Create a value of Metrics 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:findingsCount:Metrics', metrics_findingsCount - Total number of recommendations found in the code review.

$sel:meteredLinesOfCodeCount:Metrics', metrics_meteredLinesOfCodeCount - MeteredLinesOfCodeCount is the number of lines of code in the repository where the code review happened. This does not include non-code lines such as comments and blank lines.

$sel:suppressedLinesOfCodeCount:Metrics', metrics_suppressedLinesOfCodeCount - SuppressedLinesOfCodeCount is the number of lines of code in the repository where the code review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the excludeFiles variable in the aws-codeguru-reviewer.yml file. This number does not include non-code lines such as comments and blank lines.

metrics_findingsCount :: Lens' Metrics (Maybe Integer) Source #

Total number of recommendations found in the code review.

metrics_meteredLinesOfCodeCount :: Lens' Metrics (Maybe Integer) Source #

MeteredLinesOfCodeCount is the number of lines of code in the repository where the code review happened. This does not include non-code lines such as comments and blank lines.

metrics_suppressedLinesOfCodeCount :: Lens' Metrics (Maybe Integer) Source #

SuppressedLinesOfCodeCount is the number of lines of code in the repository where the code review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the analysis is based on the excludeFiles variable in the aws-codeguru-reviewer.yml file. This number does not include non-code lines such as comments and blank lines.