software.amazon.awssdk.services.personalize.model

Class CreateFilterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.personalize.model.PersonalizeRequest

software.amazon.awssdk.services.personalize.model.CreateFilterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFilterRequest
extends PersonalizeRequest
implements ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFilterRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFilterRequest.Builder	builder()
String	datasetGroupArn() The ARN of the dataset group that the filter will belong to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterExpression() The filter expression that designates the interaction types that the filter will filter out.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the filter to create.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFilterRequest.Builder>	serializableBuilderClass()
CreateFilterRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 to create.

Returns:

The name of the filter to create.

datasetGroupArn

public String datasetGroupArn()

The ARN of the dataset group that the filter will belong to.

Returns:

The ARN of the dataset group that the filter will belong to.

filterExpression

public String filterExpression()

The filter expression that designates the interaction types that the filter will filter out. A 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. To filter out all items with any interactions history, set "*" as the EVENT_TYPE. For more information, see Using Filters with Amazon Personalize.

Returns:

The filter expression that designates the interaction types that the filter will filter out. A 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. To filter out all items with any interactions history, set "*" as the EVENT_TYPE. For more information, see Using Filters with Amazon Personalize.

toBuilder

public CreateFilterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>

Specified by:

toBuilder in class PersonalizeRequest

builder

public static CreateFilterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFilterRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo