Package software.amazon.awssdk.services.xray.model

Class Tag

java.lang.Object

software.amazon.awssdk.services.xray.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 map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

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()	A tag key, such as Stage or Name.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Tag.Builder>	serializableBuilderClass()
Tag.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	An optional tag value, such as Production or test-only.

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()

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Returns:

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

value

public final String value()

An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Returns:

An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo