java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.WriteCampaignRequest

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

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

Specifies the configuration and other settings for a campaign.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WriteCampaignRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<WriteTreatmentResource>`	`additionalTreatments()`	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
`static WriteCampaignRequest.Builder`	`builder()`
`CustomDeliveryConfiguration`	`customDeliveryConfiguration()`	The delivery configuration settings for sending the campaign through a custom channel.
`String`	`description()`	A custom description of the campaign.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalTreatments()`	For responses, this returns true if the service returned a value for the AdditionalTreatments property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Integer`	`holdoutPercent()`	The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
`CampaignHook`	`hook()`	The settings for the AWS Lambda function to invoke as a code hook for the campaign.
`Boolean`	`isPaused()`	Specifies whether to pause the campaign.
`CampaignLimits`	`limits()`	The messaging limits for the campaign.
`MessageConfiguration`	`messageConfiguration()`	The message configuration settings for the campaign.
`String`	`name()`	A custom name for the campaign.
`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.
`Schedule`	`schedule()`	The schedule settings for the campaign.
`List<SdkField<?>>`	`sdkFields()`
`String`	`segmentId()`	The unique identifier for the segment to associate with the campaign.
`Integer`	`segmentVersion()`	The version of the segment to associate with the campaign.
`static Class<? extends WriteCampaignRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`
`TemplateConfiguration`	`templateConfiguration()`	The message template to use for the campaign.
`WriteCampaignRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`treatmentDescription()`	A custom description of the default treatment for the campaign.
`String`	`treatmentName()`	A custom name of the default treatment for the campaign, if the campaign has multiple treatments.

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
  - hasAdditionalTreatments
```
public final boolean hasAdditionalTreatments()
```
    For responses, this returns true if the service returned a value for the AdditionalTreatments 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.
  - additionalTreatments
```
public final List<WriteTreatmentResource> additionalTreatments()
```
    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
    
    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 hasAdditionalTreatments() method.
    
    Returns:
    
    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
  - customDeliveryConfiguration
```
public final 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.
    
    Returns:
    
    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.
  - description
```
public final String description()
```
    A custom description of the campaign.
    
    Returns:
    
    A custom description of the campaign.
  - holdoutPercent
```
public final Integer holdoutPercent()
```
    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
    
    Returns:
    
    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
  - hook
```
public final 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.
    
    Returns:
    
    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.
  - isPaused
```
public final Boolean isPaused()
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Returns:
    
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
  - limits
```
public final CampaignLimits limits()
```
    The messaging limits for the campaign.
    
    Returns:
    
    The messaging limits for the campaign.
  - messageConfiguration
```
public final MessageConfiguration messageConfiguration()
```
    The message configuration settings for the campaign.
    
    Returns:
    
    The message configuration settings for the campaign.
  - name
```
public final String name()
```
    A custom name for the campaign.
    
    Returns:
    
    A custom name for the campaign.
  - schedule
```
public final Schedule schedule()
```
    The schedule settings for the campaign.
    
    Returns:
    
    The schedule settings for the campaign.
  - segmentId
```
public final String segmentId()
```
    The unique identifier for the segment to associate with the campaign.
    
    Returns:
    
    The unique identifier for the segment to associate with the campaign.
  - segmentVersion
```
public final Integer segmentVersion()
```
    The version of the segment to associate with the campaign.
    
    Returns:
    
    The version of the segment to associate with the campaign.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final 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.
    
    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 hasTags() method.
    
    Returns:
    
    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.
  - templateConfiguration
```
public final TemplateConfiguration templateConfiguration()
```
    The message template to use for the campaign.
    
    Returns:
    
    The message template to use for the campaign.
  - treatmentDescription
```
public final String treatmentDescription()
```
    A custom description of the default treatment for the campaign.
    
    Returns:
    
    A custom description of the default treatment for the campaign.
  - treatmentName
```
public final 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.
    
    Returns:
    
    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.
  - priority
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public WriteCampaignRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WriteCampaignRequest.Builder,WriteCampaignRequest>
  - builder
```
public static WriteCampaignRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WriteCampaignRequest.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 WriteCampaignRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAdditionalTreatments

additionalTreatments

customDeliveryConfiguration

description

holdoutPercent

hook

isPaused

limits

messageConfiguration

name

schedule

segmentId

segmentVersion

hasTags

tags

templateConfiguration

treatmentDescription

treatmentName

priority

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields