software.amazon.awssdk.services.macie2.model

Class SearchResourcesSimpleCriterion

java.lang.Object

software.amazon.awssdk.services.macie2.model.SearchResourcesSimpleCriterion

All Implemented Interfaces:

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

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

Specifies a property-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchResourcesSimpleCriterion.Builder

Method Summary

Modifier and Type	Method and Description
static SearchResourcesSimpleCriterion.Builder	builder()
SearchResourcesComparator	comparator() The operator to use in the condition.
String	comparatorAsString() The operator to use in the condition.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
SearchResourcesSimpleCriterionKey	key() The property to use in the condition.
String	keyAsString() The property to use in the condition.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchResourcesSimpleCriterion.Builder>	serializableBuilderClass()
SearchResourcesSimpleCriterion.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() An array that lists one or more values to use in the condition.

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

comparator

public final SearchResourcesComparator comparator()

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

If the service returns an enum value that is not available in the current SDK version, comparator will return SearchResourcesComparator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparatorAsString().

Returns:

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

See Also:

SearchResourcesComparator

comparatorAsString

public final String comparatorAsString()

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

If the service returns an enum value that is not available in the current SDK version, comparator will return SearchResourcesComparator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparatorAsString().

Returns:

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

See Also:

SearchResourcesComparator

key

public final SearchResourcesSimpleCriterionKey key()

The property to use in the condition.

If the service returns an enum value that is not available in the current SDK version, key will return SearchResourcesSimpleCriterionKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The property to use in the condition.

See Also:

SearchResourcesSimpleCriterionKey

keyAsString

public final String keyAsString()

The property to use in the condition.

If the service returns an enum value that is not available in the current SDK version, key will return SearchResourcesSimpleCriterionKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The property to use in the condition.

See Also:

SearchResourcesSimpleCriterionKey

hasValues

public final boolean hasValues()

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

values

public final List<String> values()

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

• ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.

• S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.

• S3_BUCKET_NAME - A string that represents the name of an S3 bucket.

• S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.

Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.

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

Returns:

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

• ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.

• S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.

• S3_BUCKET_NAME - A string that represents the name of an S3 bucket.

• S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.

Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.

toBuilder

public SearchResourcesSimpleCriterion.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchResourcesSimpleCriterion.Builder,SearchResourcesSimpleCriterion>

builder

public static SearchResourcesSimpleCriterion.Builder builder()

serializableBuilderClass

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