Package software.amazon.awssdk.services.pinpoint.model

Interface WriteCampaignRequest.Builder

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

  • Method Details

    • additionalTreatments

      WriteCampaignRequest.Builder additionalTreatments(Collection<WriteTreatmentResource> additionalTreatments)

      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      Parameters:
      additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalTreatments

      WriteCampaignRequest.Builder additionalTreatments(WriteTreatmentResource... additionalTreatments)

      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      Parameters:
      additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalTreatments

      WriteCampaignRequest.Builder additionalTreatments(Consumer<WriteTreatmentResource.Builder>... additionalTreatments)

      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      This is a convenience method that creates an instance of the WriteTreatmentResource.Builder avoiding the need to create one manually via WriteTreatmentResource.builder().

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

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

    • customDeliveryConfiguration

      WriteCampaignRequest.Builder customDeliveryConfiguration(CustomDeliveryConfiguration customDeliveryConfiguration)

      The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

      Parameters:
      customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customDeliveryConfiguration

      default WriteCampaignRequest.Builder customDeliveryConfiguration(Consumer<CustomDeliveryConfiguration.Builder> customDeliveryConfiguration)

      The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

      This is a convenience method that creates an instance of the CustomDeliveryConfiguration.Builder avoiding the need to create one manually via CustomDeliveryConfiguration.builder().

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

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

    • description

      WriteCampaignRequest.Builder description(String description)

      A custom description of the campaign.

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

    • holdoutPercent

      WriteCampaignRequest.Builder holdoutPercent(Integer holdoutPercent)

      The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

      Parameters:
      holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hook

      WriteCampaignRequest.Builder hook(CampaignHook hook)

      The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

      Parameters:
      hook - The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hook

      default WriteCampaignRequest.Builder hook(Consumer<CampaignHook.Builder> hook)

      The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

      This is a convenience method that creates an instance of the CampaignHook.Builder avoiding the need to create one manually via CampaignHook.builder().

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

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

    • isPaused

      WriteCampaignRequest.Builder isPaused(Boolean isPaused)

      Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

      Parameters:
      isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limits

      WriteCampaignRequest.Builder limits(CampaignLimits limits)

      The messaging limits for the campaign.

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

    • limits

      default WriteCampaignRequest.Builder limits(Consumer<CampaignLimits.Builder> limits)

      The messaging limits for the campaign.

      This is a convenience method that creates an instance of the CampaignLimits.Builder avoiding the need to create one manually via CampaignLimits.builder().

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

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

    • messageConfiguration

      WriteCampaignRequest.Builder messageConfiguration(MessageConfiguration messageConfiguration)

      The message configuration settings for the campaign.

      Parameters:
      messageConfiguration - The message configuration settings for the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageConfiguration

      default WriteCampaignRequest.Builder messageConfiguration(Consumer<MessageConfiguration.Builder> messageConfiguration)

      The message configuration settings for the campaign.

      This is a convenience method that creates an instance of the MessageConfiguration.Builder avoiding the need to create one manually via MessageConfiguration.builder().

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

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

    • name

      WriteCampaignRequest.Builder name(String name)

      A custom name for the campaign.

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

    • schedule

      WriteCampaignRequest.Builder schedule(Schedule schedule)

      The schedule settings for the campaign.

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

    • schedule

      default WriteCampaignRequest.Builder schedule(Consumer<Schedule.Builder> schedule)

      The schedule settings for the campaign.

      This is a convenience method that creates an instance of the Schedule.Builder avoiding the need to create one manually via Schedule.builder().

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

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

    • segmentId

      WriteCampaignRequest.Builder segmentId(String segmentId)

      The unique identifier for the segment to associate with the campaign.

      Parameters:
      segmentId - The unique identifier for the segment to associate with the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentVersion

      WriteCampaignRequest.Builder segmentVersion(Integer segmentVersion)

      The version of the segment to associate with the campaign.

      Parameters:
      segmentVersion - The version of the segment to associate with the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      WriteCampaignRequest.Builder tags(Map<String,String> tags)

      As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

      (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

      Parameters:
      tags - As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

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

    • templateConfiguration

      WriteCampaignRequest.Builder templateConfiguration(TemplateConfiguration templateConfiguration)

      The message template to use for the campaign.

      Parameters:
      templateConfiguration - The message template to use for the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateConfiguration

      default WriteCampaignRequest.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)

      The message template to use for the campaign.

      This is a convenience method that creates an instance of the TemplateConfiguration.Builder avoiding the need to create one manually via TemplateConfiguration.builder().

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

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

    • treatmentDescription

      WriteCampaignRequest.Builder treatmentDescription(String treatmentDescription)

      A custom description of the default treatment for the campaign.

      Parameters:
      treatmentDescription - A custom description of the default treatment for the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatmentName

      WriteCampaignRequest.Builder treatmentName(String treatmentName)

      A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

      Parameters:
      treatmentName - A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      WriteCampaignRequest.Builder priority(Integer priority)

      Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

      Parameters:
      priority - Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.