Interface RecommendationSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RecommendationSummary.Builder,
,RecommendationSummary> SdkBuilder<RecommendationSummary.Builder,
,RecommendationSummary> SdkPojo
- Enclosing class:
RecommendationSummary
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.Last line where the recommendation is applicable in the source commit or source branch.Name of the file on which a recommendation is provided.recommendationCategory
(String recommendationCategory) The type of a recommendation.recommendationCategory
(RecommendationCategory recommendationCategory) The type of a recommendation.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.ruleMetadata
(RuleMetadata ruleMetadata) Metadata about a rule.The severity of the issue in the code that generated this recommendation.The severity of the issue in the code that generated this recommendation.Start line from where the recommendation is applicable in the source commit or source branch.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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:
-
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
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 theRuleMetadata.Builder
avoiding the need to create one manually viaRuleMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toruleMetadata(RuleMetadata)
.- Parameters:
ruleMetadata
- a consumer that will call methods onRuleMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-