Package software.amazon.awssdk.services.personalize.model

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

Modifier and Type	Method	Description
default CreateCampaignRequest.Builder	campaignConfig(Consumer<CampaignConfig.Builder> campaignConfig)	The configuration details of a campaign.
CreateCampaignRequest.Builder	campaignConfig(CampaignConfig campaignConfig)	The configuration details of a campaign.
CreateCampaignRequest.Builder	minProvisionedTPS(Integer minProvisionedTPS)	Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
CreateCampaignRequest.Builder	name(String name)	A name for the new campaign.
CreateCampaignRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCampaignRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateCampaignRequest.Builder	solutionVersionArn(String solutionVersionArn)	The Amazon Resource Name (ARN) of the solution version to deploy.
CreateCampaignRequest.Builder	tags(Collection<Tag> tags)	A list of tags to apply to the campaign.
CreateCampaignRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to apply to the campaign.
CreateCampaignRequest.Builder	tags(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, sdkFields

Method Details

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 solution version to deploy.

Parameters:

solutionVersionArn - The Amazon Resource Name (ARN) of the solution version to deploy.

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 minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

Parameters:

minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as 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 the CampaignConfig.Builder avoiding the need to create one manually via CampaignConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to campaignConfig(CampaignConfig).

Parameters:

campaignConfig - a consumer that will call methods on CampaignConfig.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 the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateCampaignRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.