Package software.amazon.awssdk.services.ram.model

Class TagFilter

java.lang.Object

software.amazon.awssdk.services.ram.model.TagFilter

All Implemented Interfaces:

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

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

A tag key and optional list of possible values that you can use to filter results for tagged resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TagFilter.Builder

Method Summary

Modifier and Type	Method	Description
static TagFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagValues()	For responses, this returns true if the service returned a value for the TagValues property.
List<SdkField<?>>	sdkFields()
static Class<? extends TagFilter.Builder>	serializableBuilderClass()
String	tagKey()	The tag key.
List<String>	tagValues()	A list of zero or more tag values.
TagFilter.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

tagKey

public final String tagKey()

The tag key. This must have a valid string value and can't be empty.

Returns:

The tag key. This must have a valid string value and can't be empty.

hasTagValues

public final boolean hasTagValues()

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

tagValues

public final List<String> tagValues()

A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.

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

Returns:

A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.

toBuilder

public TagFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TagFilter.Builder,TagFilter>

builder

public static TagFilter.Builder builder()

serializableBuilderClass

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