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

Interface Campaign.Builder

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

  • Method Details

    • name

      Campaign.Builder name(String name)

      The name of the campaign.

      Parameters:
      name - The name of the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • campaignArn

      Campaign.Builder campaignArn(String campaignArn)

      The Amazon Resource Name (ARN) of the campaign.

      Parameters:
      campaignArn - The Amazon Resource Name (ARN) of the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • solutionVersionArn

      Campaign.Builder solutionVersionArn(String solutionVersionArn)

      The Amazon Resource Name (ARN) of the solution version the campaign uses.

      Parameters:
      solutionVersionArn - The Amazon Resource Name (ARN) of the solution version the campaign uses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minProvisionedTPS

      Campaign.Builder minProvisionedTPS(Integer minProvisionedTPS)

      Specifies the requested minimum provisioned transactions (recommendations) per second. 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. 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

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

    • status

      Campaign.Builder status(String status)

      The status of the campaign.

      A campaign can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • DELETE PENDING > DELETE IN_PROGRESS

      Parameters:
      status - The status of the campaign.

      A campaign can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      • DELETE PENDING > DELETE IN_PROGRESS

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

    • failureReason

      Campaign.Builder failureReason(String failureReason)

      If a campaign fails, the reason behind the failure.

      Parameters:
      failureReason - If a campaign fails, the reason behind the failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDateTime

      Campaign.Builder creationDateTime(Instant creationDateTime)

      The date and time (in Unix format) that the campaign was created.

      Parameters:
      creationDateTime - The date and time (in Unix format) that the campaign was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedDateTime

      Campaign.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

      The date and time (in Unix format) that the campaign was last updated.

      Parameters:
      lastUpdatedDateTime - The date and time (in Unix format) that the campaign was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latestCampaignUpdate

      Campaign.Builder latestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate)
      Sets the value of the LatestCampaignUpdate property for this object.
      Parameters:
      latestCampaignUpdate - The new value for the LatestCampaignUpdate property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latestCampaignUpdate

      default Campaign.Builder latestCampaignUpdate(Consumer<CampaignUpdateSummary.Builder> latestCampaignUpdate)
      Sets the value of the LatestCampaignUpdate property for this object. This is a convenience method that creates an instance of the CampaignUpdateSummary.Builder avoiding the need to create one manually via CampaignUpdateSummary.builder().

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

      Parameters:
      latestCampaignUpdate - a consumer that will call methods on CampaignUpdateSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: