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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SimpleScopeTerm.Builder`	`builder()`
`JobComparator`	`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.
`ScopeFilterKey`	`key()`	The object property to use in the condition.
`String`	`keyAsString()`	The object property to use in the condition.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SimpleScopeTerm.Builder>`	`serializableBuilderClass()`
`SimpleScopeTerm.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`values()`	An array that lists the 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 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SimpleScopeTerm.Builder,SimpleScopeTerm>
  - 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)
```
    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

Class SimpleScopeTerm

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

comparator

comparatorAsString

key

keyAsString

hasValues

values

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields