WriteCampaignRequest (AWS Java SDK :: Services

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

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

@Generated(value="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 and Description

static interface WriteCampaignRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WriteCampaignRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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()`
`String`	`description()` The custom description of the campaign.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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 use 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()` The custom name of the campaign.
`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()` A string-to-string map of key-value pairs that defines the tags to associate with the campaign.
`WriteCampaignRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`treatmentDescription()` The custom description of a variation of the campaign to use for A/B testing.
`String`	`treatmentName()` The custom name of a variation of the campaign to use for A/B testing.

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
  - additionalTreatments
```
public 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.
    
    Returns:
    
    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
  - description
```
public String description()
```
    The custom description of the campaign.
    
    Returns:
    
    The custom description of the campaign.
  - holdoutPercent
```
public 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 CampaignHook hook()
```
    The settings for the AWS Lambda function to use as a code hook for the campaign.
    
    Returns:
    
    The settings for the AWS Lambda function to use as a code hook for the campaign.
  - isPaused
```
public Boolean isPaused()
```
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
    
    Returns:
    
    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
  - limits
```
public CampaignLimits limits()
```
    The messaging limits for the campaign.
    
    Returns:
    
    The messaging limits for the campaign.
  - messageConfiguration
```
public MessageConfiguration messageConfiguration()
```
    The message configuration settings for the campaign.
    
    Returns:
    
    The message configuration settings for the campaign.
  - name
```
public String name()
```
    The custom name of the campaign.
    
    Returns:
    
    The custom name of the campaign.
  - schedule
```
public Schedule schedule()
```
    The schedule settings for the campaign.
    
    Returns:
    
    The schedule settings for the campaign.
  - segmentId
```
public 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 Integer segmentVersion()
```
    The version of the segment to associate with the campaign.
    
    Returns:
    
    The version of the segment to associate with the campaign.
  - tags
```
public Map<String,String> tags()
```
    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.
    
    Returns:
    
    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.
  - treatmentDescription
```
public String treatmentDescription()
```
    The custom description of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    The custom description of a variation of the campaign to use for A/B testing.
  - treatmentName
```
public String treatmentName()
```
    The custom name of a variation of the campaign to use for A/B testing.
    
    Returns:
    
    The custom name of a variation of the campaign to use for A/B testing.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

additionalTreatments

description

holdoutPercent

hook

isPaused

limits

messageConfiguration

name

schedule

segmentId

segmentVersion

tags

treatmentDescription

treatmentName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields