Package software.amazon.awssdk.services.personalize.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.personalize.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>

Contains information on a recommendation filter, including its ARN, status, and filter expression.

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()
Instant	creationDateTime()	The time at which the filter was created.
String	datasetGroupArn()	The ARN of the dataset group to which the filter belongs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	If the filter failed, the reason for its failure.
String	filterArn()	The ARN of the filter.
String	filterExpression()	Specifies the type of item interactions to filter out of recommendation results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDateTime()	The time at which the filter was last updated.
String	name()	The name of the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
String	status()	The status of the filter.
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

name

public final String name()

The name of the filter.

Returns:

The name of the filter.

filterArn

public final String filterArn()

The ARN of the filter.

Returns:

The ARN of the filter.

creationDateTime

public final Instant creationDateTime()

The time at which the filter was created.

Returns:

The time at which the filter was created.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The time at which the filter was last updated.

Returns:

The time at which the filter was last updated.

datasetGroupArn

public final String datasetGroupArn()

The ARN of the dataset group to which the filter belongs.

Returns:

The ARN of the dataset group to which the filter belongs.

failureReason

public final String failureReason()

If the filter failed, the reason for its failure.

Returns:

If the filter failed, the reason for its failure.

filterExpression

public final String filterExpression()

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

Returns:

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

status

public final String status()

The status of the filter.

Returns:

The status of the filter.

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