WriteCampaignRequest (AWS SDK for Java

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>

Used to create 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()` Treatments that are defined in addition to the default treatment.
`static WriteCampaignRequest.Builder`	`builder()`
`String`	`description()` A 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 end users who will not receive messages from this campaign.
`CampaignHook`	`hook()` Campaign hook information.
`Boolean`	`isPaused()` Indicates whether the campaign is paused.
`CampaignLimits`	`limits()` The campaign limits settings.
`MessageConfiguration`	`messageConfiguration()` The message configuration settings.
`String`	`name()` The custom name of the campaign.
`Schedule`	`schedule()` The campaign schedule.
`List<SdkField<?>>`	`sdkFields()`
`String`	`segmentId()` The ID of the segment to which the campaign sends messages.
`Integer`	`segmentVersion()` The version of the segment to which the campaign sends messages.
`static Class<? extends WriteCampaignRequest.Builder>`	`serializableBuilderClass()`
`WriteCampaignRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`treatmentDescription()` A custom description for the treatment.
`String`	`treatmentName()` The custom name of a variation of the campaign used for A/B testing.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - additionalTreatments
```
public List<WriteTreatmentResource> additionalTreatments()
```
    Treatments that are defined in addition to the default treatment.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Treatments that are defined in addition to the default treatment.
  - description
```
public String description()
```
    A description of the campaign.
    
    Returns:
    
    A description of the campaign.
  - holdoutPercent
```
public Integer holdoutPercent()
```
    The allocated percentage of end users who will not receive messages from this campaign.
    
    Returns:
    
    The allocated percentage of end users who will not receive messages from this campaign.
  - hook
```
public CampaignHook hook()
```
    Campaign hook information.
    
    Returns:
    
    Campaign hook information.
  - isPaused
```
public Boolean isPaused()
```
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    
    Returns:
    
    Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  - limits
```
public CampaignLimits limits()
```
    The campaign limits settings.
    
    Returns:
    
    The campaign limits settings.
  - messageConfiguration
```
public MessageConfiguration messageConfiguration()
```
    The message configuration settings.
    
    Returns:
    
    The message configuration settings.
  - name
```
public String name()
```
    The custom name of the campaign.
    
    Returns:
    
    The custom name of the campaign.
  - schedule
```
public Schedule schedule()
```
    The campaign schedule.
    
    Returns:
    
    The campaign schedule.
  - segmentId
```
public String segmentId()
```
    The ID of the segment to which the campaign sends messages.
    
    Returns:
    
    The ID of the segment to which the campaign sends messages.
  - segmentVersion
```
public Integer segmentVersion()
```
    The version of the segment to which the campaign sends messages.
    
    Returns:
    
    The version of the segment to which the campaign sends messages.
  - treatmentDescription
```
public String treatmentDescription()
```
    A custom description for the treatment.
    
    Returns:
    
    A custom description for the treatment.
  - treatmentName
```
public String treatmentName()
```
    The custom name of a variation of the campaign used for A/B testing.
    
    Returns:
    
    The custom name of a variation of the campaign used for A/B testing.
  - toBuilder
```
public WriteCampaignRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WriteCampaignRequest.Builder,WriteCampaignRequest>
    
    Returns:
    
    a builder for type T
  - 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()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

treatmentDescription

treatmentName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields