software.amazon.awssdk.services.xray.model

Class TagResourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.xray.model.XRayRequest

software.amazon.awssdk.services.xray.model.TagResourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class TagResourceRequest
extends XRayRequest
implements ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TagResourceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static TagResourceRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	resourceARN() The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
List<SdkField<?>>	sdkFields()
static Class<? extends TagResourceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule.
TagResourceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

resourceARN

public final String resourceARN()

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

Returns:

The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference.

The following restrictions apply to tags:

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

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference.

The following restrictions apply to tags:

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

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

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

toBuilder

public TagResourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

Specified by:

toBuilder in class XRayRequest

builder

public static TagResourceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo