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(value="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 and Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method and 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 String name()

The name of the filter.

Returns:

The name of the filter.

filterArn

public String filterArn()

The ARN of the filter.

Returns:

The ARN of the filter.

creationDateTime

public Instant creationDateTime()

The time at which the filter was created.

Returns:

The time at which the filter was created.

lastUpdatedDateTime

public Instant lastUpdatedDateTime()

The time at which the filter was last updated.

Returns:

The time at which the filter was last updated.

datasetGroupArn

public 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 String failureReason()

If the filter failed, the reason for its failure.

Returns:

If the filter failed, the reason for its failure.

filterExpression

public String filterExpression()

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow the following format:

EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")

Where "EVENT_TYPE" is the type of event to filter out. For more information, see Using Filters with Amazon Personalize.

Returns:

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow the following format:

EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")

Where "EVENT_TYPE" is the type of event to filter out. For more information, see Using Filters with Amazon Personalize.

status

public 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo