Class: Aws::CodeGuruReviewer::Types::RecommendationSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb

Overview

Information about recommendations.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


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_lineInteger

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:

  • (Integer)


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_pathString

Name of the file on which a recommendation is provided.

Returns:

  • (String)


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_categoryString

The type of a recommendation.

Returns:

  • (String)


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_idString

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

Returns:

  • (String)


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_metadataTypes::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:



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

#severityString

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

Returns:

  • (String)


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_lineInteger

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

Returns:

  • (Integer)


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