Class SimpleScopeTerm
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SimpleScopeTerm.Builder
builder()
final JobComparator
The operator to use in the condition.final String
The operator to use in the condition.final boolean
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
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
The object property to use in the condition.static Class
<? extends SimpleScopeTerm.Builder> 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.values()
An array that lists the values to use in the condition.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnJobComparator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparatorAsString()
.- 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:
-
-
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 returnJobComparator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparatorAsString()
.- 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:
-
-
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 returnScopeFilterKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- The object property to use in the condition.
- See Also:
-
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 returnScopeFilterKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- The object property to use in the condition.
- See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<SimpleScopeTerm.Builder,
SimpleScopeTerm> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-