Package software.amazon.awssdk.services.resourcegroups.model

Class ResourceFilter

java.lang.Object

software.amazon.awssdk.services.resourcegroups.model.ResourceFilter

All Implemented Interfaces:

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

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

A filter name and value pair that is used to obtain more specific results from a list of resources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceFilter.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
ResourceFilterName	name()	The name of the filter.
String	nameAsString()	The name of the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceFilter.Builder>	serializableBuilderClass()
ResourceFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	One or more filter values.

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

name

public final ResourceFilterName name()

The name of the filter. Filter names are case-sensitive.

If the service returns an enum value that is not available in the current SDK version, name will return ResourceFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the filter. Filter names are case-sensitive.

See Also:

ResourceFilterName

nameAsString

public final String nameAsString()

The name of the filter. Filter names are case-sensitive.

If the service returns an enum value that is not available in the current SDK version, name will return ResourceFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the filter. Filter names are case-sensitive.

See Also:

ResourceFilterName

hasValues

public final boolean hasValues()

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

values

public final List<String> values()

One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.

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

Returns:

One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.

toBuilder

public ResourceFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceFilter.Builder,ResourceFilter>

builder

public static ResourceFilter.Builder builder()

serializableBuilderClass

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