Class Tag
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Tag.Builder,
Tag>
Adds metadata, in the form of a key:value pair, to the specified resource.
For example, you could add the tag Department:Sales
to a resource to indicate that it pertains to your
organization's sales department. You can also use tags for tag-based access control.
To learn more about tagging, see Tagging resources.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Tag.Builder
builder()
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 String
key()
The first part of a key:value pair that forms a tag associated with a given resource.static Class
<? extends Tag.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.final String
value()
The second part of a key:value pair that forms a tag associated with a given resource.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
key
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag
Department:Sales
, the key is 'Department'.- Returns:
- The first part of a key:value pair that forms a tag associated with a given resource. For example, in the
tag
Department:Sales
, the key is 'Department'.
-
value
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag
Department:Sales
, the value is 'Sales'.Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
- Returns:
- The second part of a key:value pair that forms a tag associated with a given resource. For example, in
the tag
Department:Sales
, the value is 'Sales'.Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
-
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<Tag.Builder,
Tag> - 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
-