Package 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("software.amazon.awssdk:codegen")
public final class TagResourceRequest
extends OrganizationsRequest
implements ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TagResourceRequest.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the Tags property.
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.

You can specify any of the following taggable resources.

• Amazon Web Services 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

Returns:

The ID of the resource to add a tag to.

You can specify any of the following taggable resources.

• Amazon Web Services 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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of tags to add to the specified resource.

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

If any one of the tags is not valid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to add to the specified resource.

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

If any one of the tags is not valid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.

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