Interface CreateCampaignRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>,PersonalizeRequest.Builder,SdkBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateCampaignRequest
public static interface CreateCampaignRequest.Builder extends PersonalizeRequest.Builder, SdkPojo, CopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateCampaignRequest.BuildercampaignConfig(Consumer<CampaignConfig.Builder> campaignConfig)The configuration details of a campaign.CreateCampaignRequest.BuildercampaignConfig(CampaignConfig campaignConfig)The configuration details of a campaign.CreateCampaignRequest.BuilderminProvisionedTPS(Integer minProvisionedTPS)Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.CreateCampaignRequest.Buildername(String name)A name for the new campaign.CreateCampaignRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateCampaignRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateCampaignRequest.BuildersolutionVersionArn(String solutionVersionArn)The Amazon Resource Name (ARN) of the trained model to deploy with the campaign.CreateCampaignRequest.Buildertags(Collection<Tag> tags)A list of tags to apply to the campaign.CreateCampaignRequest.Buildertags(Consumer<Tag.Builder>... tags)A list of tags to apply to the campaign.CreateCampaignRequest.Buildertags(Tag... tags)A list of tags to apply to the campaign.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.personalize.model.PersonalizeRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
name
CreateCampaignRequest.Builder name(String name)
A name for the new campaign. The campaign name must be unique within your account.
- Parameters:
name- A name for the new campaign. The campaign name must be unique within your account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionVersionArn
CreateCampaignRequest.Builder solutionVersionArn(String solutionVersionArn)
The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in
SolutionArn/$LATESTformat. You must use this format if you setsyncWithLatestSolutionVersiontoTruein the CampaignConfig.To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.
For more information about automatic campaign updates, see Enabling automatic campaign updates.
- Parameters:
solutionVersionArn- The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution inSolutionArn/$LATESTformat. You must use this format if you setsyncWithLatestSolutionVersiontoTruein the CampaignConfig.To deploy a model that isn't the latest solution version of your solution, specify the ARN of the 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.
-
minProvisionedTPS
CreateCampaignRequest.Builder minProvisionedTPS(Integer minProvisionedTPS)
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high
minProvisionedTPSwill increase your bill. We recommend starting with 1 forminProvisionedTPS(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPSas necessary.- Parameters:
minProvisionedTPS- Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A highminProvisionedTPSwill increase your bill. We recommend starting with 1 forminProvisionedTPS(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPSas necessary.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
campaignConfig
CreateCampaignRequest.Builder campaignConfig(CampaignConfig campaignConfig)
The configuration details of a campaign.
- Parameters:
campaignConfig- The configuration details of a campaign.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
campaignConfig
default CreateCampaignRequest.Builder campaignConfig(Consumer<CampaignConfig.Builder> campaignConfig)
The configuration details of a campaign.
This is a convenience method that creates an instance of theCampaignConfig.Builderavoiding the need to create one manually viaCampaignConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocampaignConfig(CampaignConfig).- Parameters:
campaignConfig- a consumer that will call methods onCampaignConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
campaignConfig(CampaignConfig)
-
tags
CreateCampaignRequest.Builder tags(Collection<Tag> tags)
A list of tags to apply to the campaign.
- Parameters:
tags- A list of tags to apply to the campaign.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateCampaignRequest.Builder tags(Tag... tags)
A list of tags to apply to the campaign.
- Parameters:
tags- A list of tags to apply to the campaign.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateCampaignRequest.Builder tags(Consumer<Tag.Builder>... tags)
A list of tags to apply to the campaign.
This is a convenience method that creates an instance of theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
overrideConfiguration
CreateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateCampaignRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-