/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.pinpoint.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

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

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RecommenderConfigurationResponse implements Serializable, Cloneable, StructuredPojo { /** *

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

*/ private java.util.Map attributes; /** *

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

*/ private String creationDate; /** *

* The custom description of the configuration for the recommender model. *

*/ private String description; /** *

* The unique identifier for the recommender model configuration. *

*/ private String id; /** *

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

*/ private String lastModifiedDate; /** *

* The custom name of the configuration for the recommender model. *

*/ private String name; /** *

* 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: *

* */ private String recommendationProviderIdType; /** *

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

*/ private String recommendationProviderRoleArn; /** *

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

*/ private String recommendationProviderUri; /** *

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

*/ private String recommendationTransformerUri; /** *

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

*/ private String recommendationsDisplayName; /** *

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

*/ private Integer recommendationsPerMessage; /** *

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

* * @return 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 java.util.Map getAttributes() { return 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. *

* * @param 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 void setAttributes(java.util.Map attributes) { this.attributes = 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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse withAttributes(java.util.Map attributes) { setAttributes(attributes); return this; } /** * Add a single Attributes entry * * @see RecommenderConfigurationResponse#withAttributes * @returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse addAttributesEntry(String key, String value) { if (null == this.attributes) { this.attributes = new java.util.HashMap(); } if (this.attributes.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.attributes.put(key, value); return this; } /** * Removes all the entries added into Attributes. * * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse clearAttributesEntries() { this.attributes = null; return this; } /** *

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

* * @param creationDate * The date, in extended ISO 8601 format, when the configuration was created for the recommender model. */ public void setCreationDate(String creationDate) { this.creationDate = creationDate; } /** *

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

* * @return The date, in extended ISO 8601 format, when the configuration was created for the recommender model. */ public String getCreationDate() { return this.creationDate; } /** *

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

* * @param creationDate * The date, in extended ISO 8601 format, when the configuration was created for the recommender model. * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse withCreationDate(String creationDate) { setCreationDate(creationDate); return this; } /** *

* The custom description of the configuration for the recommender model. *

* * @param description * The custom description of the configuration for the recommender model. */ public void setDescription(String description) { this.description = description; } /** *

* The custom description of the configuration for the recommender model. *

* * @return The custom description of the configuration for the recommender model. */ public String getDescription() { return this.description; } /** *

* The custom description of the configuration for the recommender model. *

* * @param description * The custom description of the configuration for the recommender model. * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse withDescription(String description) { setDescription(description); return this; } /** *

* The unique identifier for the recommender model configuration. *

* * @param id * The unique identifier for the recommender model configuration. */ public void setId(String id) { this.id = id; } /** *

* The unique identifier for the recommender model configuration. *

* * @return The unique identifier for the recommender model configuration. */ public String getId() { return this.id; } /** *

* The unique identifier for the recommender model configuration. *

* * @param id * The unique identifier for the recommender model configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse withId(String id) { setId(id); return this; } /** *

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

* * @param lastModifiedDate * The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified. */ public void setLastModifiedDate(String lastModifiedDate) { this.lastModifiedDate = lastModifiedDate; } /** *

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

* * @return The date, in extended ISO 8601 format, when the configuration for the recommender model was last * modified. */ public String getLastModifiedDate() { return this.lastModifiedDate; } /** *

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

* * @param lastModifiedDate * The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified. * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse withLastModifiedDate(String lastModifiedDate) { setLastModifiedDate(lastModifiedDate); return this; } /** *

* The custom name of the configuration for the recommender model. *

* * @param name * The custom name of the configuration for the recommender model. */ public void setName(String name) { this.name = name; } /** *

* The custom name of the configuration for the recommender model. *

* * @return The custom name of the configuration for the recommender model. */ public String getName() { return this.name; } /** *

* The custom name of the configuration for the recommender model. *

* * @param name * The custom name of the configuration for the recommender model. * @return Returns a reference to this object so that method calls can be chained together. */ public RecommenderConfigurationResponse withName(String name) { setName(name); return this; } /** *

* 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: *

* * * @param 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:

*