Package software.amazon.awssdk.services.sagemaker.model

Class Tag

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Tag

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Tag.Builder,Tag>

@Generated("software.amazon.awssdk:codegen")
public final class Tag
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Tag.Builder,Tag>

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Tag.Builder

Method Summary

Modifier and Type	Method	Description
static Tag.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The tag key.
List<SdkField<?>>	sdkFields()
static Class<? extends Tag.Builder>	serializableBuilderClass()
Tag.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The tag value.

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

key

public final String key()

The tag key. Tag keys must be unique per resource.

Returns:

The tag key. Tag keys must be unique per resource.

value

public final String value()

The tag value.

Returns:

The tag value.

toBuilder

public Tag.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Tag.Builder,Tag>

builder

public static Tag.Builder builder()

serializableBuilderClass

public static Class<? extends Tag.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo