com.amazonaws.services.personalize.model

Class CampaignConfig

java.lang.Object

com.amazonaws.services.personalize.model.CampaignConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

The configuration details of a campaign.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CampaignConfig()

Method Summary

Modifier and Type	Method and Description
CampaignConfig	addItemExplorationConfigEntry(String key, String value) Add a single ItemExplorationConfig entry
CampaignConfig	clearItemExplorationConfigEntries() Removes all the entries added into ItemExplorationConfig.
CampaignConfig	clone()
boolean	equals(Object obj)
Boolean	getEnableMetadataWithRecommendations() Whether metadata with recommendations is enabled for the campaign.
Map<String,String>	getItemExplorationConfig() Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items.
Boolean	getSyncWithLatestSolutionVersion() Whether the campaign automatically updates to use the latest solution version (trained model) of a solution.
int	hashCode()
Boolean	isEnableMetadataWithRecommendations() Whether metadata with recommendations is enabled for the campaign.
Boolean	isSyncWithLatestSolutionVersion() Whether the campaign automatically updates to use the latest solution version (trained model) of a solution.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEnableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations) Whether metadata with recommendations is enabled for the campaign.
void	setItemExplorationConfig(Map<String,String> itemExplorationConfig) Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items.
void	setSyncWithLatestSolutionVersion(Boolean syncWithLatestSolutionVersion) Whether the campaign automatically updates to use the latest solution version (trained model) of a solution.
String	toString() Returns a string representation of this object.
CampaignConfig	withEnableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations) Whether metadata with recommendations is enabled for the campaign.
CampaignConfig	withItemExplorationConfig(Map<String,String> itemExplorationConfig) Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items.
CampaignConfig	withSyncWithLatestSolutionVersion(Boolean syncWithLatestSolutionVersion) Whether the campaign automatically updates to use the latest solution version (trained model) of a solution.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CampaignConfig

public CampaignConfig()

Method Detail

getItemExplorationConfig

public Map<String,String> getItemExplorationConfig()

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

Returns:

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

setItemExplorationConfig

public void setItemExplorationConfig(Map<String,String> itemExplorationConfig)

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

Parameters:

itemExplorationConfig - Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

withItemExplorationConfig

public CampaignConfig withItemExplorationConfig(Map<String,String> itemExplorationConfig)

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

Parameters:

itemExplorationConfig - Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

Returns:

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

addItemExplorationConfigEntry

public CampaignConfig addItemExplorationConfigEntry(String key,
                                                    String value)

Add a single ItemExplorationConfig entry

See Also:

withItemExplorationConfig(java.util.Map<java.lang.String, java.lang.String>)

clearItemExplorationConfigEntries

public CampaignConfig clearItemExplorationConfigEntries()

Removes all the entries added into ItemExplorationConfig.

Returns:

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

setEnableMetadataWithRecommendations

public void setEnableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations)

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Parameters:

enableMetadataWithRecommendations - Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

getEnableMetadataWithRecommendations

public Boolean getEnableMetadataWithRecommendations()

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Returns:

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

withEnableMetadataWithRecommendations

public CampaignConfig withEnableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations)

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Parameters:

enableMetadataWithRecommendations - Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Returns:

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

isEnableMetadataWithRecommendations

public Boolean isEnableMetadataWithRecommendations()

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Returns:

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

setSyncWithLatestSolutionVersion

public void setSyncWithLatestSolutionVersion(Boolean syncWithLatestSolutionVersion)

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Parameters:

syncWithLatestSolutionVersion - Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

getSyncWithLatestSolutionVersion

public Boolean getSyncWithLatestSolutionVersion()

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Returns:

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

withSyncWithLatestSolutionVersion

public CampaignConfig withSyncWithLatestSolutionVersion(Boolean syncWithLatestSolutionVersion)

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Parameters:

syncWithLatestSolutionVersion - Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Returns:

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

isSyncWithLatestSolutionVersion

public Boolean isSyncWithLatestSolutionVersion()

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

Returns:

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify True, you must specify the ARN of your solution for the SolutionVersionArn parameter. It must be in SolutionArn/$LATEST format. The default is False and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CampaignConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.