Class TagScopeTerm
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TagScopeTerm.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 TagValues property.final String
key()
The object property to use in the condition.static Class
<? extends TagScopeTerm.Builder> final List
<TagValuePair> The tag keys or tag key and value pairs to use in the condition.final TagTarget
target()
The type of object to apply the condition to.final String
The type of object to apply the condition to.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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,
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 are EQ (equals) or NE (not equals).
- See Also:
-
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,
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 are EQ (equals) or NE (not equals).
- See Also:
-
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
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
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,
target
will 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:
-
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,
target
will 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:
-
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<TagScopeTerm.Builder,
TagScopeTerm> - 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
-