RecommendationSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codegurureviewer.model.RecommendationSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RecommendationSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about recommendations.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RecommendationSummary()

Constructors
Constructor and Description
`RecommendationSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecommendationSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
`Integer`	`getEndLine()` Last line where the recommendation is applicable in the source commit or source branch.
`String`	`getFilePath()` Name of the file on which a recommendation is provided.
`String`	`getRecommendationCategory()` The type of a recommendation.
`String`	`getRecommendationId()` The recommendation ID that can be used to track the provided recommendations.
`RuleMetadata`	`getRuleMetadata()` Metadata about a rule.
`String`	`getSeverity()` The severity of the issue in the code that generated this recommendation.
`Integer`	`getStartLine()` Start line from where the recommendation is applicable in the source commit or source branch.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
`void`	`setEndLine(Integer endLine)` Last line where the recommendation is applicable in the source commit or source branch.
`void`	`setFilePath(String filePath)` Name of the file on which a recommendation is provided.
`void`	`setRecommendationCategory(String recommendationCategory)` The type of a recommendation.
`void`	`setRecommendationId(String recommendationId)` The recommendation ID that can be used to track the provided recommendations.
`void`	`setRuleMetadata(RuleMetadata ruleMetadata)` Metadata about a rule.
`void`	`setSeverity(String severity)` The severity of the issue in the code that generated this recommendation.
`void`	`setStartLine(Integer startLine)` Start line from where the recommendation is applicable in the source commit or source branch.
`String`	`toString()` Returns a string representation of this object.
`RecommendationSummary`	`withDescription(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`	`withEndLine(Integer endLine)` Last line where the recommendation is applicable in the source commit or source branch.
`RecommendationSummary`	`withFilePath(String filePath)` Name of the file on which a recommendation is provided.
`RecommendationSummary`	`withRecommendationCategory(RecommendationCategory recommendationCategory)` The type of a recommendation.
`RecommendationSummary`	`withRecommendationCategory(String recommendationCategory)` The type of a recommendation.
`RecommendationSummary`	`withRecommendationId(String recommendationId)` The recommendation ID that can be used to track the provided recommendations.
`RecommendationSummary`	`withRuleMetadata(RuleMetadata ruleMetadata)` Metadata about a rule.
`RecommendationSummary`	`withSeverity(Severity severity)` The severity of the issue in the code that generated this recommendation.
`RecommendationSummary`	`withSeverity(String severity)` The severity of the issue in the code that generated this recommendation.
`RecommendationSummary`	`withStartLine(Integer startLine)` Start line from where the recommendation is applicable in the source commit or source branch.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecommendationSummary
```
public RecommendationSummary()
```
- Method Detail
  - setFilePath
```
public void setFilePath(String filePath)
```
    Name of the file on which a recommendation is provided.
    
    Parameters:
    
    filePath - Name of the file on which a recommendation is provided.
  - getFilePath
```
public String getFilePath()
```
    Name of the file on which a recommendation is provided.
    
    Returns:
    
    Name of the file on which a recommendation is provided.
  - withFilePath
```
public RecommendationSummary withFilePath(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.
  - setRecommendationId
```
public void setRecommendationId(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.
  - getRecommendationId
```
public String getRecommendationId()
```
    The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
    
    Returns:
    
    The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.
  - withRecommendationId
```
public RecommendationSummary withRecommendationId(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.
  - setStartLine
```
public void setStartLine(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.
  - getStartLine
```
public Integer getStartLine()
```
    Start line from where the recommendation is applicable in the source commit or source branch.
    
    Returns:
    
    Start line from where the recommendation is applicable in the source commit or source branch.
  - withStartLine
```
public RecommendationSummary withStartLine(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.
  - setEndLine
```
public void setEndLine(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.
  - getEndLine
```
public Integer getEndLine()
```
    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:
    
    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.
  - withEndLine
```
public RecommendationSummary withEndLine(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.
  - setDescription
```
public void setDescription(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.
  - getDescription
```
public String getDescription()
```
    A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
    
    Returns:
    
    A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.
  - withDescription
```
public RecommendationSummary withDescription(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.
  - setRecommendationCategory
```
public void setRecommendationCategory(String recommendationCategory)
```
    The type of a recommendation.
    
    Parameters:
    
    recommendationCategory - The type of a recommendation.
    
    See Also:
    
    RecommendationCategory
  - getRecommendationCategory
```
public String getRecommendationCategory()
```
    The type of a recommendation.
    
    Returns:
    
    The type of a recommendation.
    
    See Also:
    
    RecommendationCategory
  - withRecommendationCategory
```
public RecommendationSummary withRecommendationCategory(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
  - withRecommendationCategory
```
public RecommendationSummary withRecommendationCategory(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
  - setRuleMetadata
```
public void setRuleMetadata(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.
  - getRuleMetadata
```
public RuleMetadata getRuleMetadata()
```
    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:
    
    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.
  - withRuleMetadata
```
public RecommendationSummary withRuleMetadata(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.
  - setSeverity
```
public void setSeverity(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.
    
    See Also:
    
    Severity
  - getSeverity
```
public String getSeverity()
```
    The severity of the issue in the code that generated this recommendation.
    
    Returns:
    
    The severity of the issue in the code that generated this recommendation.
    
    See Also:
    
    Severity
  - withSeverity
```
public RecommendationSummary withSeverity(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
  - withSeverity
```
public RecommendationSummary withSeverity(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
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RecommendationSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class RecommendationSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecommendationSummary

Method Detail

setFilePath

getFilePath

withFilePath

setRecommendationId

getRecommendationId

withRecommendationId

setStartLine

getStartLine

withStartLine

setEndLine

getEndLine

withEndLine

setDescription

getDescription

withDescription

setRecommendationCategory

getRecommendationCategory

withRecommendationCategory

withRecommendationCategory

setRuleMetadata

getRuleMetadata

withRuleMetadata

setSeverity

getSeverity

withSeverity

withSeverity

toString

equals

hashCode

clone

marshall