java.lang.Object
- software.amazon.awssdk.services.personalize.model.CampaignConfig

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CampaignConfig.Builder,CampaignConfig>

@Generated("software.amazon.awssdk:codegen")
public final class CampaignConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CampaignConfig.Builder,CampaignConfig>

The configuration details of a campaign.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CampaignConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CampaignConfig.Builder`	`builder()`
`Boolean`	`enableMetadataWithRecommendations()`	Whether metadata with recommendations is enabled for the campaign.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasItemExplorationConfig()`	For responses, this returns true if the service returned a value for the ItemExplorationConfig property.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CampaignConfig.Builder>`	`serializableBuilderClass()`
`Boolean`	`syncWithLatestSolutionVersion()`	Whether the campaign automatically updates to use the latest solution version (trained model) of a solution.
`CampaignConfig.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasItemExplorationConfig
```
public final boolean hasItemExplorationConfig()
```
    For responses, this returns true if the service returned a value for the ItemExplorationConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - itemExplorationConfig
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItemExplorationConfig() method.
    
    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.
  - enableMetadataWithRecommendations
```
public final 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.
    
    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.
  - syncWithLatestSolutionVersion
```
public final 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.
    
    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.
  - toBuilder
```
public CampaignConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CampaignConfig.Builder,CampaignConfig>
  - builder
```
public static CampaignConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CampaignConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CampaignConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasItemExplorationConfig

itemExplorationConfig

enableMetadataWithRecommendations

syncWithLatestSolutionVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields