Class: Aws::CodeGuruReviewer::Types::RecommendationSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodeGuruReviewer::Types::RecommendationSummary
- Defined in:
- gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb
Overview
Information about recommendations.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#description ⇒ String
A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
-
#end_line ⇒ Integer
Last line where the recommendation is applicable in the source commit or source branch.
-
#file_path ⇒ String
Name of the file on which a recommendation is provided.
-
#recommendation_category ⇒ String
The type of a recommendation.
-
#recommendation_id ⇒ String
The recommendation ID that can be used to track the provided recommendations.
-
#rule_metadata ⇒ Types::RuleMetadata
Metadata about a rule.
-
#severity ⇒ String
The severity of the issue in the code that generated this recommendation.
-
#start_line ⇒ Integer
Start line from where the recommendation is applicable in the source commit or source branch.
Instance Attribute Details
#description ⇒ String
A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#end_line ⇒ Integer
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.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#file_path ⇒ String
Name of the file on which a recommendation is provided.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#recommendation_category ⇒ String
The type of a recommendation.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#recommendation_id ⇒ String
The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#rule_metadata ⇒ Types::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.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#severity ⇒ String
The severity of the issue in the code that generated this recommendation.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |
#start_line ⇒ Integer
Start line from where the recommendation is applicable in the source commit or source branch.
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 |
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1650 class RecommendationSummary < Struct.new( :file_path, :recommendation_id, :start_line, :end_line, :description, :recommendation_category, :rule_metadata, :severity) SENSITIVE = [] include Aws::Structure end |