@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RecommenderConfigurationResponse extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
Constructor and Description |
---|
RecommenderConfigurationResponse() |
Modifier and Type | Method and Description |
---|---|
RecommenderConfigurationResponse |
addAttributesEntry(String key,
String value)
Add a single Attributes entry
|
RecommenderConfigurationResponse |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
RecommenderConfigurationResponse |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the
RecommendationProviderIdType property.
|
String |
getCreationDate()
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
|
String |
getDescription()
The custom description of the configuration for the recommender model.
|
String |
getId()
The unique identifier for the recommender model configuration.
|
String |
getLastModifiedDate()
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
|
String |
getName()
The custom name of the configuration for the recommender model.
|
String |
getRecommendationProviderIdType()
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model.
|
String |
getRecommendationProviderRoleArn()
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 |
getRecommendationProviderUri()
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data
from.
|
String |
getRecommendationsDisplayName()
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 |
getRecommendationsPerMessage()
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 |
getRecommendationTransformerUri()
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.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAttributes(Map<String,String> attributes)
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the
RecommendationProviderIdType property.
|
void |
setCreationDate(String creationDate)
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
|
void |
setDescription(String description)
The custom description of the configuration for the recommender model.
|
void |
setId(String id)
The unique identifier for the recommender model configuration.
|
void |
setLastModifiedDate(String lastModifiedDate)
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
|
void |
setName(String name)
The custom name of the configuration for the recommender model.
|
void |
setRecommendationProviderIdType(String recommendationProviderIdType)
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model.
|
void |
setRecommendationProviderRoleArn(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.
|
void |
setRecommendationProviderUri(String recommendationProviderUri)
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data
from.
|
void |
setRecommendationsDisplayName(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.
|
void |
setRecommendationsPerMessage(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.
|
void |
setRecommendationTransformerUri(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.
|
String |
toString()
Returns a string representation of this object.
|
RecommenderConfigurationResponse |
withAttributes(Map<String,String> attributes)
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the
RecommendationProviderIdType property.
|
RecommenderConfigurationResponse |
withCreationDate(String creationDate)
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
|
RecommenderConfigurationResponse |
withDescription(String description)
The custom description of the configuration for the recommender model.
|
RecommenderConfigurationResponse |
withId(String id)
The unique identifier for the recommender model configuration.
|
RecommenderConfigurationResponse |
withLastModifiedDate(String lastModifiedDate)
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
|
RecommenderConfigurationResponse |
withName(String name)
The custom name of the configuration for the recommender model.
|
RecommenderConfigurationResponse |
withRecommendationProviderIdType(String recommendationProviderIdType)
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model.
|
RecommenderConfigurationResponse |
withRecommendationProviderRoleArn(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.
|
RecommenderConfigurationResponse |
withRecommendationProviderUri(String recommendationProviderUri)
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data
from.
|
RecommenderConfigurationResponse |
withRecommendationsDisplayName(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.
|
RecommenderConfigurationResponse |
withRecommendationsPerMessage(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.
|
RecommenderConfigurationResponse |
withRecommendationTransformerUri(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 Map<String,String> getAttributes()
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.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
public void setAttributes(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.
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.
public RecommenderConfigurationResponse withAttributes(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.
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.
public RecommenderConfigurationResponse addAttributesEntry(String key, String value)
public RecommenderConfigurationResponse clearAttributesEntries()
public void setCreationDate(String creationDate)
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
creationDate
- The date, in extended ISO 8601 format, when the configuration was created for the recommender model.public String getCreationDate()
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
public RecommenderConfigurationResponse withCreationDate(String creationDate)
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
creationDate
- The date, in extended ISO 8601 format, when the configuration was created for the recommender model.public void setDescription(String description)
The custom description of the configuration for the recommender model.
description
- The custom description of the configuration for the recommender model.public String getDescription()
The custom description of the configuration for the recommender model.
public RecommenderConfigurationResponse withDescription(String description)
The custom description of the configuration for the recommender model.
description
- The custom description of the configuration for the recommender model.public void setId(String id)
The unique identifier for the recommender model configuration.
id
- The unique identifier for the recommender model configuration.public String getId()
The unique identifier for the recommender model configuration.
public RecommenderConfigurationResponse withId(String id)
The unique identifier for the recommender model configuration.
id
- The unique identifier for the recommender model configuration.public void setLastModifiedDate(String lastModifiedDate)
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
lastModifiedDate
- The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.public String getLastModifiedDate()
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
public RecommenderConfigurationResponse withLastModifiedDate(String lastModifiedDate)
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
lastModifiedDate
- The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.public void setName(String name)
The custom name of the configuration for the recommender model.
name
- The custom name of the configuration for the recommender model.public String getName()
The custom name of the configuration for the recommender model.
public RecommenderConfigurationResponse withName(String name)
The custom name of the configuration for the recommender model.
name
- The custom name of the configuration for the recommender model.public void setRecommendationProviderIdType(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.
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.
public String getRecommendationProviderIdType()
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 RecommenderConfigurationResponse withRecommendationProviderIdType(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.
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.
public void setRecommendationProviderRoleArn(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.
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 String getRecommendationProviderRoleArn()
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 RecommenderConfigurationResponse withRecommendationProviderRoleArn(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.
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 void setRecommendationProviderUri(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.
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 String getRecommendationProviderUri()
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 RecommenderConfigurationResponse withRecommendationProviderUri(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.
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 void setRecommendationTransformerUri(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.
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 String getRecommendationTransformerUri()
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 RecommenderConfigurationResponse withRecommendationTransformerUri(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.
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 void setRecommendationsDisplayName(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.
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.
public String getRecommendationsDisplayName()
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 RecommenderConfigurationResponse withRecommendationsDisplayName(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.
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.
public void setRecommendationsPerMessage(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.
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 Integer getRecommendationsPerMessage()
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 withRecommendationsPerMessage(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.
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 String toString()
toString
in class Object
Object.toString()
public RecommenderConfigurationResponse clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.