software.amazon.awssdk.services.wafv2.model

Class TagInfoForResource

java.lang.Object

software.amazon.awssdk.services.wafv2.model.TagInfoForResource

All Implemented Interfaces:

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

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

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TagInfoForResource.Builder

Method Summary

Modifier and Type	Method and Description
static TagInfoForResource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagList() For responses, this returns true if the service returned a value for the TagList property.
String	resourceARN() The Amazon Resource Name (ARN) of the resource.
List<SdkField<?>>	sdkFields()
static Class<? extends TagInfoForResource.Builder>	serializableBuilderClass()
List<Tag>	tagList() The array of Tag objects defined for the resource.
TagInfoForResource.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

hasTagList

public final boolean hasTagList()

For responses, this returns true if the service returned a value for the TagList 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.

tagList

public final List<Tag> tagList()

The array of Tag objects defined for the resource.

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 hasTagList() method.

Returns:

The array of Tag objects defined for the resource.

toBuilder

public TagInfoForResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TagInfoForResource.Builder,TagInfoForResource>

builder

public static TagInfoForResource.Builder builder()

serializableBuilderClass

public static Class<? extends TagInfoForResource.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