Package software.amazon.awssdk.services.macie2.model

Class SimpleScopeTerm

java.lang.Object

software.amazon.awssdk.services.macie2.model.SimpleScopeTerm

All Implemented Interfaces:

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

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

Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimpleScopeTerm.Builder

Method Summary

Modifier and Type	Method	Description
static SimpleScopeTerm.Builder	builder()
final JobComparator	comparator()	The operator to use in the condition.
final String	comparatorAsString()	The operator to use in the condition.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
final ScopeFilterKey	key()	The object property to use in the condition.
final String	keyAsString()	The object property to use in the condition.
final List<SdkField<?>>	sdkFields()
static Class<? extends SimpleScopeTerm.Builder>	serializableBuilderClass()
SimpleScopeTerm.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final List<String>	values()	An array that lists the values to use in the condition.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

comparator

public final JobComparator comparator()

The operator to use in the condition. Valid values for each supported property (key) are:

• OBJECT_EXTENSION - EQ (equals) or NE (not equals)

• OBJECT_KEY - STARTS_WITH

• OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

• OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

If the service returns an enum value that is not available in the current SDK version, comparator will return JobComparator.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 for each supported property (key) are:

• OBJECT_EXTENSION - EQ (equals) or NE (not equals)

• OBJECT_KEY - STARTS_WITH

• OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

• OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

See Also:

• JobComparator

comparatorAsString

public final String comparatorAsString()

The operator to use in the condition. Valid values for each supported property (key) are:

• OBJECT_EXTENSION - EQ (equals) or NE (not equals)

• OBJECT_KEY - STARTS_WITH

• OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

• OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

If the service returns an enum value that is not available in the current SDK version, comparator will return JobComparator.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 for each supported property (key) are:

• OBJECT_EXTENSION - EQ (equals) or NE (not equals)

• OBJECT_KEY - STARTS_WITH

• OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

• OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

See Also:

• JobComparator

key

public final ScopeFilterKey key()

The object 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 ScopeFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The object property to use in the condition.

See Also:

• ScopeFilterKey

keyAsString

public final String keyAsString()

The object 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 ScopeFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The object property to use in the condition.

See Also:

• ScopeFilterKey

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 the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

• OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

• OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

• OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2023-09-24T14:31:13Z

• OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

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 the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

• OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf

• OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.

• OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2023-09-24T14:31:13Z

• OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

toBuilder

public SimpleScopeTerm.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SimpleScopeTerm.Builder,SimpleScopeTerm>

Returns:

a builder for type T

builder

public static SimpleScopeTerm.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.