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

Class AnalysisRuleCriteria

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.AnalysisRuleCriteria

All Implemented Interfaces:

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

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

The criteria for an analysis rule for an analyzer. The criteria determine which entities will generate findings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalysisRuleCriteria.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	accountIds()	A list of Amazon Web Services account IDs to apply to the analysis rule criteria.
static AnalysisRuleCriteria.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccountIds()	For responses, this returns true if the service returned a value for the AccountIds property.
int	hashCode()
boolean	hasResourceTags()	For responses, this returns true if the service returned a value for the ResourceTags property.
List<Map<String,String>>	resourceTags()	An array of key-value pairs to match for your resources.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisRuleCriteria.Builder>	serializableBuilderClass()
AnalysisRuleCriteria.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

hasAccountIds

public final boolean hasAccountIds()

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

accountIds

public final List<String> accountIds()

A list of Amazon Web Services account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. The list cannot include more than 2,000 account IDs.

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

Returns:

A list of Amazon Web Services account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. The list cannot include more than 2,000 account IDs.

hasResourceTags

public final boolean hasResourceTags()

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

resourceTags

public final List<Map<String,String>> resourceTags()

An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:.

For the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key.

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

Returns:

An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:.

For the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key.

toBuilder

public AnalysisRuleCriteria.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisRuleCriteria.Builder,AnalysisRuleCriteria>

builder

public static AnalysisRuleCriteria.Builder builder()

serializableBuilderClass

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