software.amazon.awssdk.services.pinpoint.model

Class RecommenderConfigurationResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.RecommenderConfigurationResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class RecommenderConfigurationResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecommenderConfigurationResponse.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property.
static RecommenderConfigurationResponse.Builder	builder()
String	creationDate() The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
String	description() The custom description of the configuration for the recommender model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	id() The unique identifier for the recommender model configuration.
String	lastModifiedDate() The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
String	name() The custom name of the configuration for the recommender model.
String	recommendationProviderIdType() The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model.
String	recommendationProviderRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
String	recommendationProviderUri() The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from.
String	recommendationsDisplayName() The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property.
Integer	recommendationsPerMessage() The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property.
String	recommendationTransformerUri() The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
List<SdkField<?>>	sdkFields()
static Class<? extends RecommenderConfigurationResponse.Builder>	serializableBuilderClass()
RecommenderConfigurationResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasAttributes

public final boolean hasAttributes()

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

attributes

public final Map<String,String> attributes()

A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

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

Returns:

A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

creationDate

public final String creationDate()

The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

Returns:

The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

description

public final String description()

The custom description of the configuration for the recommender model.

Returns:

The custom description of the configuration for the recommender model.

id

public final String id()

The unique identifier for the recommender model configuration.

Returns:

The unique identifier for the recommender model configuration.

lastModifiedDate

public final String lastModifiedDate()

The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

Returns:

The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

name

public final String name()

The custom name of the configuration for the recommender model.

Returns:

The custom name of the configuration for the recommender model.

recommendationProviderIdType

public final String recommendationProviderIdType()

The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

• PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

• PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

Returns:

The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

• PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

• PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

recommendationProviderRoleArn

public final String recommendationProviderRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

recommendationProviderUri

public final String recommendationProviderUri()

The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

Returns:

The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

recommendationTransformerUri

public final String recommendationTransformerUri()

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

Returns:

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

recommendationsDisplayName

public final String recommendationsDisplayName()

The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

Returns:

The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

recommendationsPerMessage

public final Integer recommendationsPerMessage()

The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

Returns:

The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

toBuilder

public RecommenderConfigurationResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>

Returns:

a builder for type T

builder

public static RecommenderConfigurationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.