Class TagScopeTerm
- java.lang.Object
-
- software.amazon.awssdk.services.macie2.model.TagScopeTerm
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<TagScopeTerm.Builder,TagScopeTerm>
@Generated("software.amazon.awssdk:codegen") public final class TagScopeTerm extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TagScopeTerm.Builder,TagScopeTerm>
Specifies a tag-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 interfaceTagScopeTerm.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TagScopeTerm.Builderbuilder()JobComparatorcomparator()The operator to use in the condition.StringcomparatorAsString()The operator to use in the condition.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTagValues()For responses, this returns true if the service returned a value for the TagValues property.Stringkey()The object property to use in the condition.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends TagScopeTerm.Builder>serializableBuilderClass()List<TagValuePair>tagValues()The tag keys or tag key and value pairs to use in the condition.TagTargettarget()The type of object to apply the condition to.StringtargetAsString()The type of object to apply the condition to.TagScopeTerm.BuildertoBuilder()StringtoString()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
-
comparator
public final JobComparator comparator()
The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).
If the service returns an enum value that is not available in the current SDK version,
comparatorwill 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 are EQ (equals) or NE (not equals).
- See Also:
JobComparator
-
comparatorAsString
public final String comparatorAsString()
The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).
If the service returns an enum value that is not available in the current SDK version,
comparatorwill 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 are EQ (equals) or NE (not equals).
- See Also:
JobComparator
-
key
public final String key()
The object property to use in the condition. The only valid value is TAG.
- Returns:
- The object property to use in the condition. The only valid value is TAG.
-
hasTagValues
public final boolean hasTagValues()
For responses, this returns true if the service returned a value for the TagValues 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.
-
tagValues
public final List<TagValuePair> tagValues()
The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.
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
hasTagValues()method.- Returns:
- The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.
-
target
public final TagTarget target()
The type of object to apply the condition to.
If the service returns an enum value that is not available in the current SDK version,
targetwill returnTagTarget.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtargetAsString().- Returns:
- The type of object to apply the condition to.
- See Also:
TagTarget
-
targetAsString
public final String targetAsString()
The type of object to apply the condition to.
If the service returns an enum value that is not available in the current SDK version,
targetwill returnTagTarget.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtargetAsString().- Returns:
- The type of object to apply the condition to.
- See Also:
TagTarget
-
toBuilder
public TagScopeTerm.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<TagScopeTerm.Builder,TagScopeTerm>
-
builder
public static TagScopeTerm.Builder builder()
-
serializableBuilderClass
public static Class<? extends TagScopeTerm.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-