Package software.amazon.awssdk.services.customerprofiles.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.Filter

All Implemented Interfaces:

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

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

Defines how to filter the objects coming in for calculated attributes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method	Description
static Filter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<FilterGroup>	groups()	Holds the list of Filter groups within the Filter definition.
boolean	hasGroups()	For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
Include	include()	Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.
String	includeAsString()	Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Filter.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

include

public final Include include()

Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.

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

Returns:

Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.

See Also:

Include

includeAsString

public final String includeAsString()

Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.

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

Returns:

Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.

See Also:

Include

hasGroups

public final boolean hasGroups()

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

groups

public final List<FilterGroup> groups()

Holds the list of Filter groups within the Filter definition.

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

Returns:

Holds the list of Filter groups within the Filter definition.

toBuilder

public Filter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

builder

public static Filter.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo