Class PushMessageActivity
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PushMessageActivity.Builder,
PushMessageActivity>
Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PushMessageActivity.Builder
builder()
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 int
hashCode()
final JourneyPushMessage
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.final String
The unique identifier for the next activity to perform, after the message is sent.static Class
<? extends PushMessageActivity.Builder> final String
The name of the push notification template to use for the message.final String
The unique identifier for the version of the push notification template to use for the message.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
messageConfig
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
- Returns:
- Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
-
nextActivity
The unique identifier for the next activity to perform, after the message is sent.
- Returns:
- The unique identifier for the next activity to perform, after the message is sent.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
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<PushMessageActivity.Builder,
PushMessageActivity> - 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
-