Class MetricsSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MetricsSummary.Builder,
MetricsSummary>
Information about metrics summaries.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MetricsSummary.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
Total number of recommendations found in the code review.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Long
Lines of code metered in the code review.static Class
<? extends MetricsSummary.Builder> final Long
Lines of code suppressed in the code review based on theexcludeFiles
element in theaws-codeguru-reviewer.yml
file.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.- Returns:
- 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
Lines of code suppressed in the code review based on the
excludeFiles
element in theaws-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 theaws-codeguru-reviewer.yml
file, thenSuppressedLinesOfCodeCount
returns 200 (2 * 100) as the total number of lines of code suppressed. However, if you submit a pull request for the same repository, thenSuppressedLinesOfCodeCount
only includes the lines in the 2 files that changed. If only 1 of the 2 files changed in the pull request, thenSuppressedLinesOfCodeCount
returns 100 (1 * 100) as the total number of lines of code suppressed.- Returns:
- Lines of code suppressed in the code review based on the
excludeFiles
element in theaws-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 theaws-codeguru-reviewer.yml
file, thenSuppressedLinesOfCodeCount
returns 200 (2 * 100) as the total number of lines of code suppressed. However, if you submit a pull request for the same repository, thenSuppressedLinesOfCodeCount
only includes the lines in the 2 files that changed. If only 1 of the 2 files changed in the pull request, thenSuppressedLinesOfCodeCount
returns 100 (1 * 100) as the total number of lines of code suppressed.
-
findingsCount
Total number of recommendations found in the code review.
- Returns:
- Total number of recommendations found in the code review.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MetricsSummary.Builder,
MetricsSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-