Package 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("software.amazon.awssdk:codegen")
public final class CreateFilterRequest
extends PersonalizeRequest
implements ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFilterRequest.Builder

Method Summary

Modifier and Type	Method	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 defines which items are included or excluded from recommendations.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the filter to create.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFilterRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to apply to the filter.
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 final String name()

The name of the filter to create.

Returns:

The name of the filter to create.

datasetGroupArn

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

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

Returns:

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of tags to apply to the filter.

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

Returns:

A list of tags to apply to the filter.

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

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo