Class TagSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.TagSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TagSpecification.Builder,TagSpecification>
@Generated("software.amazon.awssdk:codegen") public final class TagSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TagSpecification.Builder,TagSpecification>
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
The
Valid Values
lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TagSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TagSpecification.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.ResourceType
resourceType()
The type of resource to tag on creation.String
resourceTypeAsString()
The type of resource to tag on creation.List<SdkField<?>>
sdkFields()
static Class<? extends TagSpecification.Builder>
serializableBuilderClass()
List<Tag>
tags()
The tags to apply to the resource.TagSpecification.Builder
toBuilder()
String
toString()
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
-
resourceType
public final ResourceType resourceType()
The type of resource to tag on creation.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of resource to tag on creation.
- See Also:
ResourceType
-
resourceTypeAsString
public final String resourceTypeAsString()
The type of resource to tag on creation.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of resource to tag on creation.
- See Also:
ResourceType
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
The tags to apply to the resource.
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
hasTags()
method.- Returns:
- The tags to apply to the resource.
-
toBuilder
public TagSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TagSpecification.Builder,TagSpecification>
-
builder
public static TagSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends TagSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-