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)


1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1196

class RecommendationSummary < Struct.new(
  :file_path,
  :recommendation_id,
  :start_line,
  :end_line,
  :description)
  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)


1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1196

class RecommendationSummary < Struct.new(
  :file_path,
  :recommendation_id,
  :start_line,
  :end_line,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#file_pathString

Name of the file on which a recommendation is provided.

Returns:

  • (String)


1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1196

class RecommendationSummary < Struct.new(
  :file_path,
  :recommendation_id,
  :start_line,
  :end_line,
  :description)
  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)


1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1196

class RecommendationSummary < Struct.new(
  :file_path,
  :recommendation_id,
  :start_line,
  :end_line,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#start_lineInteger

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

Returns:

  • (Integer)


1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1196

class RecommendationSummary < Struct.new(
  :file_path,
  :recommendation_id,
  :start_line,
  :end_line,
  :description)
  SENSITIVE = []
  include Aws::Structure
end