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

Class CreateRecommenderRequest

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.CreateRecommenderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRecommenderRequest.Builder,CreateRecommenderRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRecommenderRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateRecommenderRequest.Builder	builder()
String	datasetGroupArn()	The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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 recommender.
String	recipeArn()	The Amazon Resource Name (ARN) of the recipe that the recommender will use.
RecommenderConfig	recommenderConfig()	The configuration details of the recommender.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRecommenderRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to apply to the recommender.
CreateRecommenderRequest.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 recommender.

Returns:

The name of the recommender.

datasetGroupArn

public final String datasetGroupArn()

The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

Returns:

The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

recipeArn

public final String recipeArn()

The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.

Returns:

The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.

recommenderConfig

public final RecommenderConfig recommenderConfig()

The configuration details of the recommender.

Returns:

The configuration details of the recommender.

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 recommender.

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 recommender.

toBuilder

public CreateRecommenderRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRecommenderRequest.Builder,CreateRecommenderRequest>

Specified by:

toBuilder in class PersonalizeRequest

builder

public static CreateRecommenderRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRecommenderRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo