Package software.amazon.awssdk.services.codegurureviewer.model

Class RuleMetadata

java.lang.Object

software.amazon.awssdk.services.codegurureviewer.model.RuleMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RuleMetadata.Builder,RuleMetadata>

@Generated("software.amazon.awssdk:codegen")
public final class RuleMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuleMetadata.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static RuleMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRuleTags()	For responses, this returns true if the service returned a value for the RuleTags property.
String	longDescription()	A long description of the rule.
String	ruleId()	The ID of the rule.
String	ruleName()	The name of the rule.
List<String>	ruleTags()	Tags that are associated with the rule.
List<SdkField<?>>	sdkFields()
static Class<? extends RuleMetadata.Builder>	serializableBuilderClass()
String	shortDescription()	A short description of the rule.
RuleMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ruleId

public final String ruleId()

The ID of the rule.

Returns:

The ID of the rule.

ruleName

public final String ruleName()

The name of the rule.

Returns:

The name of the rule.

shortDescription

public final String shortDescription()

A short description of the rule.

Returns:

A short description of the rule.

longDescription

public final String longDescription()

A long description of the rule.

Returns:

A long description of the rule.

hasRuleTags

public final boolean hasRuleTags()

For responses, this returns true if the service returned a value for the RuleTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ruleTags

public final List<String> ruleTags()

Tags that are associated with the rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuleTags() method.

Returns:

Tags that are associated with the rule.

toBuilder

public RuleMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleMetadata.Builder,RuleMetadata>

builder

public static RuleMetadata.Builder builder()

serializableBuilderClass

public static Class<? extends RuleMetadata.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo