com.amazonaws.services.personalize.model

Class CreateFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.personalize.model.CreateFilterRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFilterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFilterRequest()

Method Summary

Modifier and Type	Method and Description
CreateFilterRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDatasetGroupArn() The ARN of the dataset group that the filter will belong to.
String	getFilterExpression() The filter expression that designates the interaction types that the filter will filter out.
String	getName() The name of the filter to create.
int	hashCode()
void	setDatasetGroupArn(String datasetGroupArn) The ARN of the dataset group that the filter will belong to.
void	setFilterExpression(String filterExpression) The filter expression that designates the interaction types that the filter will filter out.
void	setName(String name) The name of the filter to create.
String	toString() Returns a string representation of this object.
CreateFilterRequest	withDatasetGroupArn(String datasetGroupArn) The ARN of the dataset group that the filter will belong to.
CreateFilterRequest	withFilterExpression(String filterExpression) The filter expression that designates the interaction types that the filter will filter out.
CreateFilterRequest	withName(String name) The name of the filter to create.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFilterRequest

public CreateFilterRequest()

Method Detail

setName

public void setName(String name)

The name of the filter to create.

Parameters:

name - The name of the filter to create.

getName

public String getName()

The name of the filter to create.

Returns:

The name of the filter to create.

withName

public CreateFilterRequest withName(String name)

The name of the filter to create.

Parameters:

name - The name of the filter to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatasetGroupArn

public void setDatasetGroupArn(String datasetGroupArn)

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

Parameters:

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

getDatasetGroupArn

public String getDatasetGroupArn()

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.

withDatasetGroupArn

public CreateFilterRequest withDatasetGroupArn(String datasetGroupArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilterExpression

public void setFilterExpression(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.

Parameters:

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.

getFilterExpression

public String getFilterExpression()

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.

withFilterExpression

public CreateFilterRequest withFilterExpression(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateFilterRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()