@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PushMessageActivity extends Object implements Serializable, Cloneable, StructuredPojo
Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
Constructor and Description |
---|
PushMessageActivity() |
Modifier and Type | Method and Description |
---|---|
PushMessageActivity |
clone() |
boolean |
equals(Object obj) |
JourneyPushMessage |
getMessageConfig()
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
|
String |
getNextActivity()
The unique identifier for the next activity to perform, after the message is sent.
|
String |
getTemplateName()
The name of the push notification template to use for the message.
|
String |
getTemplateVersion()
The unique identifier for the version of the push notification template to use for the message.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setMessageConfig(JourneyPushMessage messageConfig)
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
|
void |
setNextActivity(String nextActivity)
The unique identifier for the next activity to perform, after the message is sent.
|
void |
setTemplateName(String templateName)
The name of the push notification template to use for the message.
|
void |
setTemplateVersion(String templateVersion)
The unique identifier for the version of the push notification template to use for the message.
|
String |
toString()
Returns a string representation of this object.
|
PushMessageActivity |
withMessageConfig(JourneyPushMessage messageConfig)
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
|
PushMessageActivity |
withNextActivity(String nextActivity)
The unique identifier for the next activity to perform, after the message is sent.
|
PushMessageActivity |
withTemplateName(String templateName)
The name of the push notification template to use for the message.
|
PushMessageActivity |
withTemplateVersion(String templateVersion)
The unique identifier for the version of the push notification template to use for the message.
|
public void setMessageConfig(JourneyPushMessage messageConfig)
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
messageConfig
- Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.public JourneyPushMessage getMessageConfig()
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
public PushMessageActivity withMessageConfig(JourneyPushMessage messageConfig)
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
messageConfig
- Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.public void setNextActivity(String nextActivity)
The unique identifier for the next activity to perform, after the message is sent.
nextActivity
- The unique identifier for the next activity to perform, after the message is sent.public String getNextActivity()
The unique identifier for the next activity to perform, after the message is sent.
public PushMessageActivity withNextActivity(String nextActivity)
The unique identifier for the next activity to perform, after the message is sent.
nextActivity
- The unique identifier for the next activity to perform, after the message is sent.public void setTemplateName(String templateName)
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
templateName
- The name of the push notification template to use for the message. If specified, this value must match the
name of an existing message template.public String getTemplateName()
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
public PushMessageActivity withTemplateName(String templateName)
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
templateName
- The name of the push notification template to use for the message. If specified, this value must match the
name of an existing message template.public void setTemplateVersion(String templateVersion)
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
templateVersion
- The unique identifier for the version of the push notification template to use for the message. If
specified, this value must match the identifier for an existing template version. To retrieve a list of
versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
public String getTemplateVersion()
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
public PushMessageActivity withTemplateVersion(String templateVersion)
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
templateVersion
- The unique identifier for the version of the push notification template to use for the message. If
specified, this value must match the identifier for an existing template version. To retrieve a list of
versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
public String toString()
toString
in class Object
Object.toString()
public PushMessageActivity clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.