@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.
Modifier and Type | Class and Description |
---|---|
static interface |
RecommenderConfigurationResponse.Builder |
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()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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.
|
copy
public final boolean hasAttributes()
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.
You can use hasAttributes()
to see if a value was sent in this field.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
public final String creationDate()
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
public final String description()
The custom description of the configuration for the recommender model.
public final String id()
The unique identifier for the recommender model configuration.
public final String lastModifiedDate()
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
public final String name()
The custom name of the configuration for the recommender model.
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.
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.
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.
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.
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.
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.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
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.
public RecommenderConfigurationResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>
public static RecommenderConfigurationResponse.Builder builder()
public static Class<? extends RecommenderConfigurationResponse.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.