com.amazonaws.services.codegurureviewer.model

Class RuleMetadata

java.lang.Object

com.amazonaws.services.codegurureviewer.model.RuleMetadata

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleMetadata()

Method Summary

Modifier and Type	Method and Description
RuleMetadata	clone()
boolean	equals(Object obj)
String	getLongDescription() A long description of the rule.
String	getRuleId() The ID of the rule.
String	getRuleName() The name of the rule.
List<String>	getRuleTags() Tags that are associated with the rule.
String	getShortDescription() A short description of the rule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setLongDescription(String longDescription) A long description of the rule.
void	setRuleId(String ruleId) The ID of the rule.
void	setRuleName(String ruleName) The name of the rule.
void	setRuleTags(Collection<String> ruleTags) Tags that are associated with the rule.
void	setShortDescription(String shortDescription) A short description of the rule.
String	toString() Returns a string representation of this object.
RuleMetadata	withLongDescription(String longDescription) A long description of the rule.
RuleMetadata	withRuleId(String ruleId) The ID of the rule.
RuleMetadata	withRuleName(String ruleName) The name of the rule.
RuleMetadata	withRuleTags(Collection<String> ruleTags) Tags that are associated with the rule.
RuleMetadata	withRuleTags(String... ruleTags) Tags that are associated with the rule.
RuleMetadata	withShortDescription(String shortDescription) A short description of the rule.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleMetadata

public RuleMetadata()

Method Detail

setRuleId

public void setRuleId(String ruleId)

The ID of the rule.

Parameters:

ruleId - The ID of the rule.

getRuleId

public String getRuleId()

The ID of the rule.

Returns:

The ID of the rule.

withRuleId

public RuleMetadata withRuleId(String ruleId)

The ID of the rule.

Parameters:

ruleId - The ID of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRuleName

public void setRuleName(String ruleName)

The name of the rule.

Parameters:

ruleName - The name of the rule.

getRuleName

public String getRuleName()

The name of the rule.

Returns:

The name of the rule.

withRuleName

public RuleMetadata withRuleName(String ruleName)

The name of the rule.

Parameters:

ruleName - The name of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setShortDescription

public void setShortDescription(String shortDescription)

A short description of the rule.

Parameters:

shortDescription - A short description of the rule.

getShortDescription

public String getShortDescription()

A short description of the rule.

Returns:

A short description of the rule.

withShortDescription

public RuleMetadata withShortDescription(String shortDescription)

A short description of the rule.

Parameters:

shortDescription - A short description of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLongDescription

public void setLongDescription(String longDescription)

A long description of the rule.

Parameters:

longDescription - A long description of the rule.

getLongDescription

public String getLongDescription()

A long description of the rule.

Returns:

A long description of the rule.

withLongDescription

public RuleMetadata withLongDescription(String longDescription)

A long description of the rule.

Parameters:

longDescription - A long description of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRuleTags

public List<String> getRuleTags()

Tags that are associated with the rule.

Returns:

Tags that are associated with the rule.

setRuleTags

public void setRuleTags(Collection<String> ruleTags)

Tags that are associated with the rule.

Parameters:

ruleTags - Tags that are associated with the rule.

withRuleTags

public RuleMetadata withRuleTags(String... ruleTags)

Tags that are associated with the rule.

NOTE: This method appends the values to the existing list (if any). Use setRuleTags(java.util.Collection) or withRuleTags(java.util.Collection) if you want to override the existing values.

Parameters:

ruleTags - Tags that are associated with the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRuleTags

public RuleMetadata withRuleTags(Collection<String> ruleTags)

Tags that are associated with the rule.

Parameters:

ruleTags - Tags that are associated with the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

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 RuleMetadata clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo