Package software.amazon.awssdk.services.accessanalyzer.model

Class AnalysisRule

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.AnalysisRule

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class AnalysisRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisRule.Builder,AnalysisRule>

Contains information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalysisRule.Builder

Method Summary

Modifier and Type	Method	Description
static AnalysisRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<AnalysisRuleCriteria>	exclusions()	A list of rules for the analyzer containing criteria to exclude from analysis.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExclusions()	For responses, this returns true if the service returned a value for the Exclusions property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisRule.Builder>	serializableBuilderClass()
AnalysisRule.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

hasExclusions

public final boolean hasExclusions()

For responses, this returns true if the service returned a value for the Exclusions 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.

exclusions

public final List<AnalysisRuleCriteria> exclusions()

A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.

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 hasExclusions() method.

Returns:

A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.

toBuilder

public AnalysisRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisRule.Builder,AnalysisRule>

builder

public static AnalysisRule.Builder builder()

serializableBuilderClass

public static Class<? extends AnalysisRule.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo