software.amazon.awssdk.services.organizations.model

Class TagResourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.organizations.model.OrganizationsRequest

software.amazon.awssdk.services.organizations.model.TagResourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class TagResourceRequest
extends OrganizationsRequest
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	resourceId() The ID of the resource to add a tag to.
List<SdkField<?>>	sdkFields()
static Class<? extends TagResourceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags to add to the specified resource.
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

resourceId

public final String resourceId()

The ID of the resource to add a tag to.

Returns:

The ID of the resource to add a tag to.

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 list of tags to add to the specified resource.

You can specify any of the following taggable resources.

• AWS account – specify the account ID number.

• Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz

• Root – specify the root ID that begins with r- and looks similar to: r-1a2b

• Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account user, then the entire request fails and the account is not created.

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 list of tags to add to the specified resource.

You can specify any of the following taggable resources.

• AWS account – specify the account ID number.

• Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz

• Root – specify the root ID that begins with r- and looks similar to: r-1a2b

• Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account user, then the entire request fails and the account is not created.

toBuilder

public TagResourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

Specified by:

toBuilder in class OrganizationsRequest

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