CampaignResponse (AWS Java SDK :: Services :: Amazon Pinpoint 2.17.46 API)

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CampaignResponse.Builder,CampaignResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CampaignResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CampaignResponse.Builder,CampaignResponse>
```
Provides information about the status, configuration, and other settings for a campaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CampaignResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<TreatmentResource>`	`additionalTreatments()` An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
`String`	`applicationId()` The unique identifier for the application that the campaign applies to.
`String`	`arn()` The Amazon Resource Name (ARN) of the campaign.
`static CampaignResponse.Builder`	`builder()`
`String`	`creationDate()` The date, in ISO 8601 format, when the campaign was created.
`CustomDeliveryConfiguration`	`customDeliveryConfiguration()` The delivery configuration settings for sending the campaign through a custom channel.
`CampaignState`	`defaultState()` The current status of the campaign's default treatment.
`String`	`description()` The 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 use as a code hook for the campaign.
`String`	`id()` The unique identifier for the campaign.
`Boolean`	`isPaused()` Specifies whether the campaign is paused.
`String`	`lastModifiedDate()` The date, in ISO 8601 format, when the campaign was last modified.
`CampaignLimits`	`limits()` The messaging limits for the campaign.
`MessageConfiguration`	`messageConfiguration()` The message configuration settings for the campaign.
`String`	`name()` The name of 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 that's associated with the campaign.
`Integer`	`segmentVersion()` The version number of the segment that's associated with the campaign.
`static Class<? extends CampaignResponse.Builder>`	`serializableBuilderClass()`
`CampaignState`	`state()` The current status of the campaign.
`Map<String,String>`	`tags()` A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign.
`TemplateConfiguration`	`templateConfiguration()` The message template that’s used for the campaign.
`CampaignResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`treatmentDescription()` The custom description of the default treatment for the campaign.
`String`	`treatmentName()` The custom name of the default treatment for the campaign, if the campaign has multiple treatments.
`Integer`	`version()` The version number of the campaign.

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<TreatmentResource> additionalTreatments()
```
    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
    
    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 responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
  - applicationId
```
public final String applicationId()
```
    The unique identifier for the application that the campaign applies to.
    
    Returns:
    
    The unique identifier for the application that the campaign applies to.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the campaign.
  - creationDate
```
public final String creationDate()
```
    The date, in ISO 8601 format, when the campaign was created.
    
    Returns:
    
    The date, in ISO 8601 format, when the campaign was created.
  - customDeliveryConfiguration
```
public final CustomDeliveryConfiguration customDeliveryConfiguration()
```
    The delivery configuration settings for sending the campaign through a custom channel.
    
    Returns:
    
    The delivery configuration settings for sending the campaign through a custom channel.
  - defaultState
```
public final CampaignState defaultState()
```
    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
    
    Returns:
    
    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
  - description
```
public final String description()
```
    The custom description of the campaign.
    
    Returns:
    
    The 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 use 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 use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
  - id
```
public final String id()
```
    The unique identifier for the campaign.
    
    Returns:
    
    The unique identifier for the campaign.
  - isPaused
```
public final Boolean isPaused()
```
    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
    
    Returns:
    
    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
  - lastModifiedDate
```
public final String lastModifiedDate()
```
    The date, in ISO 8601 format, when the campaign was last modified.
    
    Returns:
    
    The date, in ISO 8601 format, when the campaign was last modified.
  - 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()
```
    The name of the campaign.
    
    Returns:
    
    The name of 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 that's associated with the campaign.
    
    Returns:
    
    The unique identifier for the segment that's associated with the campaign.
  - segmentVersion
```
public final Integer segmentVersion()
```
    The version number of the segment that's associated with the campaign.
    
    Returns:
    
    The version number of the segment that's associated with the campaign.
  - state
```
public final CampaignState state()
```
    The current status of the campaign.
    
    Returns:
    
    The current status of 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()
```
    A string-to-string map of key-value pairs that identifies the tags that are associated 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:
    
    A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
  - templateConfiguration
```
public final TemplateConfiguration templateConfiguration()
```
    The message template that’s used for the campaign.
    
    Returns:
    
    The message template that’s used for the campaign.
  - treatmentDescription
```
public final String treatmentDescription()
```
    The custom description of the default treatment for the campaign.
    
    Returns:
    
    The custom description of the default treatment for the campaign.
  - treatmentName
```
public final String treatmentName()
```
    The 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:
    
    The 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.
  - version
```
public final Integer version()
```
    The version number of the campaign.
    
    Returns:
    
    The version number of the campaign.
  - 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 CampaignResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CampaignResponse.Builder,CampaignResponse>
  - builder
```
public static CampaignResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CampaignResponse.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 CampaignResponse

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

applicationId

arn

creationDate

customDeliveryConfiguration

defaultState

description

holdoutPercent

hook

id

isPaused

lastModifiedDate

limits

messageConfiguration

name

schedule

segmentId

segmentVersion

state

hasTags

tags

templateConfiguration

treatmentDescription

treatmentName

version

priority

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields