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.MetricsSummary

Description

Documentation

data MetricsSummary Source #

Information about metrics summaries.

See: newMetricsSummary smart constructor.

Constructors

MetricsSummary'

Fields

findingsCount :: Maybe Integer
Total number of recommendations found in the code review.
meteredLinesOfCodeCount :: Maybe Integer
Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code.
suppressedLinesOfCodeCount :: Maybe Integer
Lines of code suppressed in the code review based on the excludeFiles element in the aws-codeguru-reviewer.yml file. For full repository analyses, this number includes all lines of code in the files that are suppressed. For pull requests, this number only includes the changed lines of code that are suppressed. In both cases, this number does not include non-code lines such as comments and import statements. For example, if you initiate a full repository analysis on a repository containing 5 files, each file with 100 lines of code, and 2 files are listed as excluded in the aws-codeguru-reviewer.yml file, then SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of lines of code suppressed. However, if you submit a pull request for the same repository, then SuppressedLinesOfCodeCount only includes the lines in the 2 files that changed. If only 1 of the 2 files changed in the pull request, then SuppressedLinesOfCodeCount returns 100 (1 * 100) as the total number of lines of code suppressed.

Instances

Instances details

FromJSON MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Methods parseJSON :: Value -> Parser MetricsSummary # parseJSONList :: Value -> Parser [MetricsSummary] #
Generic MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Associated Types type Rep MetricsSummary :: Type -> Type # Methods from :: MetricsSummary -> Rep MetricsSummary x # to :: Rep MetricsSummary x -> MetricsSummary #
Read MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Methods readsPrec :: Int -> ReadS MetricsSummary # readList :: ReadS [MetricsSummary] # readPrec :: ReadPrec MetricsSummary # readListPrec :: ReadPrec [MetricsSummary] #
Show MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Methods showsPrec :: Int -> MetricsSummary -> ShowS # show :: MetricsSummary -> String # showList :: [MetricsSummary] -> ShowS #
NFData MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Methods rnf :: MetricsSummary -> () #
Eq MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Methods (==) :: MetricsSummary -> MetricsSummary -> Bool # (/=) :: MetricsSummary -> MetricsSummary -> Bool #
Hashable MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary Methods hashWithSalt :: Int -> MetricsSummary -> Int # hash :: MetricsSummary -> Int #
type Rep MetricsSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.MetricsSummary type Rep MetricsSummary = D1 ('MetaData "MetricsSummary" "Amazonka.CodeGuruReviewer.Types.MetricsSummary" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "MetricsSummary'" '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)))))

newMetricsSummary :: MetricsSummary Source #

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

$sel:meteredLinesOfCodeCount:MetricsSummary', metricsSummary_meteredLinesOfCodeCount - Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code.

$sel:suppressedLinesOfCodeCount:MetricsSummary', metricsSummary_suppressedLinesOfCodeCount - Lines of code suppressed in the code review based on the excludeFiles element in the aws-codeguru-reviewer.yml file. For full repository analyses, this number includes all lines of code in the files that are suppressed. For pull requests, this number only includes the changed lines of code that are suppressed. In both cases, this number does not include non-code lines such as comments and import statements. For example, if you initiate a full repository analysis on a repository containing 5 files, each file with 100 lines of code, and 2 files are listed as excluded in the aws-codeguru-reviewer.yml file, then SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of lines of code suppressed. However, if you submit a pull request for the same repository, then SuppressedLinesOfCodeCount only includes the lines in the 2 files that changed. If only 1 of the 2 files changed in the pull request, then SuppressedLinesOfCodeCount returns 100 (1 * 100) as the total number of lines of code suppressed.

metricsSummary_findingsCount :: Lens' MetricsSummary (Maybe Integer) Source #

Total number of recommendations found in the code review.

metricsSummary_meteredLinesOfCodeCount :: Lens' MetricsSummary (Maybe Integer) Source #

Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code.

metricsSummary_suppressedLinesOfCodeCount :: Lens' MetricsSummary (Maybe Integer) Source #

Lines of code suppressed in the code review based on the excludeFiles element in the aws-codeguru-reviewer.yml file. For full repository analyses, this number includes all lines of code in the files that are suppressed. For pull requests, this number only includes the changed lines of code that are suppressed. In both cases, this number does not include non-code lines such as comments and import statements. For example, if you initiate a full repository analysis on a repository containing 5 files, each file with 100 lines of code, and 2 files are listed as excluded in the aws-codeguru-reviewer.yml file, then SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of lines of code suppressed. However, if you submit a pull request for the same repository, then SuppressedLinesOfCodeCount only includes the lines in the 2 files that changed. If only 1 of the 2 files changed in the pull request, then SuppressedLinesOfCodeCount returns 100 (1 * 100) as the total number of lines of code suppressed.