software.amazon.awssdk.services.codegurureviewer.model

Interface RecommendationSummary.Builder

All Superinterfaces:

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

Enclosing class:

RecommendationSummary

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

Method Summary

Modifier and Type	Method and Description
RecommendationSummary.Builder	description(String description) A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
RecommendationSummary.Builder	endLine(Integer endLine) Last line where the recommendation is applicable in the source commit or source branch.
RecommendationSummary.Builder	filePath(String filePath) Name of the file on which a recommendation is provided.
RecommendationSummary.Builder	recommendationCategory(RecommendationCategory recommendationCategory) The type of a recommendation.
RecommendationSummary.Builder	recommendationCategory(String recommendationCategory) The type of a recommendation.
RecommendationSummary.Builder	recommendationId(String recommendationId) The recommendation ID that can be used to track the provided recommendations.
default RecommendationSummary.Builder	ruleMetadata(Consumer<RuleMetadata.Builder> ruleMetadata) Metadata about a rule.
RecommendationSummary.Builder	ruleMetadata(RuleMetadata ruleMetadata) Metadata about a rule.
RecommendationSummary.Builder	severity(Severity severity) The severity of the issue in the code that generated this recommendation.
RecommendationSummary.Builder	severity(String severity) The severity of the issue in the code that generated this recommendation.
RecommendationSummary.Builder	startLine(Integer startLine) Start line from where the recommendation is applicable in the source commit or source branch.

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

filePath

RecommendationSummary.Builder filePath(String filePath)

Name of the file on which a recommendation is provided.

Parameters:

filePath - Name of the file on which a recommendation is provided.

Returns:

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

recommendationId

RecommendationSummary.Builder recommendationId(String recommendationId)

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

Parameters:

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

Returns:

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

startLine

RecommendationSummary.Builder startLine(Integer startLine)

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

Parameters:

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

Returns:

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

endLine

RecommendationSummary.Builder endLine(Integer 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.

Parameters:

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.

Returns:

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

description

RecommendationSummary.Builder description(String description)

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

Parameters:

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

Returns:

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

recommendationCategory

RecommendationSummary.Builder recommendationCategory(String recommendationCategory)

The type of a recommendation.

Parameters:

recommendationCategory - The type of a recommendation.

Returns:

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

See Also:

RecommendationCategory, RecommendationCategory

recommendationCategory

RecommendationSummary.Builder recommendationCategory(RecommendationCategory recommendationCategory)

The type of a recommendation.

Parameters:

recommendationCategory - The type of a recommendation.

Returns:

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

See Also:

RecommendationCategory, RecommendationCategory

ruleMetadata

RecommendationSummary.Builder ruleMetadata(RuleMetadata 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.

Parameters:

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.

Returns:

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

ruleMetadata

default RecommendationSummary.Builder ruleMetadata(Consumer<RuleMetadata.Builder> 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.

This is a convenience method that creates an instance of the RuleMetadata.Builder avoiding the need to create one manually via RuleMetadata.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleMetadata(RuleMetadata).

Parameters:

ruleMetadata - a consumer that will call methods on RuleMetadata.Builder

Returns:

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

See Also:

ruleMetadata(RuleMetadata)

severity

RecommendationSummary.Builder severity(String severity)

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

Parameters:

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

Returns:

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

See Also:

Severity, Severity

severity

RecommendationSummary.Builder severity(Severity severity)

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

Parameters:

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

Returns:

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

See Also:

Severity, Severity