Class WriteCampaignRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WriteCampaignRequest.Builder,
WriteCampaignRequest>
Specifies the configuration and other settings for a campaign.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<WriteTreatmentResource> An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.static WriteCampaignRequest.Builder
builder()
The delivery configuration settings for sending the campaign through a custom channel.final String
A custom description of the campaign.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdditionalTreatments property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.final CampaignHook
hook()
The settings for the AWS Lambda function to invoke as a code hook for the campaign.final Boolean
isPaused()
Specifies whether to pause the campaign.final CampaignLimits
limits()
The messaging limits for the campaign.final MessageConfiguration
The message configuration settings for the campaign.final String
name()
A custom name for the campaign.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.final Schedule
schedule()
The schedule settings for the campaign.final String
The unique identifier for the segment to associate with the campaign.final Integer
The version of the segment to associate with the campaign.static Class
<? extends WriteCampaignRequest.Builder> tags()
final TemplateConfiguration
The message template to use for the campaign.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
A custom description of the default treatment for the campaign.final String
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
A custom description of the campaign.
- Returns:
- A custom description of the campaign.
-
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
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
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
The messaging limits for the campaign.
- Returns:
- The messaging limits for the campaign.
-
messageConfiguration
The message configuration settings for the campaign.
- Returns:
- The message configuration settings for the campaign.
-
name
A custom name for the campaign.
- Returns:
- A custom name for the campaign.
-
schedule
The schedule settings for the campaign.
- Returns:
- The schedule settings for the campaign.
-
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
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 theisEmpty()
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
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
The message template to use for the campaign.
- Returns:
- The message template to use for the campaign.
-
treatmentDescription
A custom description of the default treatment for the campaign.
- Returns:
- A custom description of the default treatment for the campaign.
-
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
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
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 interfaceToCopyableBuilder<WriteCampaignRequest.Builder,
WriteCampaignRequest> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-