software.amazon.awssdk.services.codegurureviewer.model

Interface MetricsSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MetricsSummary.Builder,MetricsSummary>, SdkBuilder<MetricsSummary.Builder,MetricsSummary>, SdkPojo

Enclosing class:

MetricsSummary

public static interface MetricsSummary.Builder
extends SdkPojo, CopyableBuilder<MetricsSummary.Builder,MetricsSummary>

Method Summary

Modifier and Type	Method and Description
MetricsSummary.Builder	findingsCount(Long findingsCount) Total number of recommendations found in the code review.
MetricsSummary.Builder	meteredLinesOfCodeCount(Long meteredLinesOfCodeCount) Lines of code metered in the code review.
MetricsSummary.Builder	suppressedLinesOfCodeCount(Long suppressedLinesOfCodeCount) Lines of code suppressed in the code review based on the excludeFiles element in the aws-codeguru-reviewer.yml file.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

meteredLinesOfCodeCount

MetricsSummary.Builder meteredLinesOfCodeCount(Long 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

suppressedLinesOfCodeCount

MetricsSummary.Builder suppressedLinesOfCodeCount(Long 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

findingsCount

MetricsSummary.Builder findingsCount(Long findingsCount)

Total number of recommendations found in the code review.

Parameters:

findingsCount - Total number of recommendations found in the code review.

Returns:

Returns a reference to this object so that method calls can be chained together.