Package software.amazon.awssdk.services.pinpoint.model

Interface RecommenderConfigurationResponse.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>, SdkBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>, SdkPojo
Enclosing class:
RecommenderConfigurationResponse
public static interface RecommenderConfigurationResponse.Builder extends SdkPojo, CopyableBuilder<RecommenderConfigurationResponse.Builder,RecommenderConfigurationResponse>

  • Method Details

    • attributes

      RecommenderConfigurationResponse.Builder attributes(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      RecommenderConfigurationResponse.Builder creationDate(String creationDate)

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

      Parameters:
      creationDate - The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      RecommenderConfigurationResponse.Builder description(String description)

      The custom description of the configuration for the recommender model.

      Parameters:
      description - The custom description of the configuration for the recommender model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      RecommenderConfigurationResponse.Builder id(String id)

      The unique identifier for the recommender model configuration.

      Parameters:
      id - The unique identifier for the recommender model configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedDate

      RecommenderConfigurationResponse.Builder lastModifiedDate(String lastModifiedDate)

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

      Parameters:
      lastModifiedDate - The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      RecommenderConfigurationResponse.Builder name(String name)

      The custom name of the configuration for the recommender model.

      Parameters:
      name - The custom name of the configuration for the recommender model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationProviderIdType

      RecommenderConfigurationResponse.Builder recommendationProviderIdType(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationProviderRoleArn

      RecommenderConfigurationResponse.Builder recommendationProviderRoleArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationProviderUri

      RecommenderConfigurationResponse.Builder recommendationProviderUri(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationTransformerUri

      RecommenderConfigurationResponse.Builder recommendationTransformerUri(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationsDisplayName

      RecommenderConfigurationResponse.Builder recommendationsDisplayName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationsPerMessage

      RecommenderConfigurationResponse.Builder recommendationsPerMessage(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.