PushNotificationTemplateResponse (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PushNotificationTemplateResponse.Builder,PushNotificationTemplateResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class PushNotificationTemplateResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PushNotificationTemplateResponse.Builder,PushNotificationTemplateResponse>
```
Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PushNotificationTemplateResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AndroidPushNotificationTemplate`	`adm()` The message template that's used for the ADM (Amazon Device Messaging) channel.
`APNSPushNotificationTemplate`	`apns()` The message template that's used for the APNs (Apple Push Notification service) channel.
`String`	`arn()` The Amazon Resource Name (ARN) of the message template.
`AndroidPushNotificationTemplate`	`baidu()` The message template that's used for the Baidu (Baidu Cloud Push) channel.
`static PushNotificationTemplateResponse.Builder`	`builder()`
`String`	`creationDate()` The date, in ISO 8601 format, when the message template was created.
`String`	`defaultSubstitutions()` The JSON object that specifies the default values that are used for message variables in the message template.
`DefaultPushNotificationTemplate`	`defaultValue()` The default message template that's used for push notification channels.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`AndroidPushNotificationTemplate`	`gcm()` The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`lastModifiedDate()` The date, in ISO 8601 format, when the message template was last modified.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PushNotificationTemplateResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
`String`	`templateDescription()` The custom description of the message template.
`String`	`templateName()` The name of the message template.
`TemplateType`	`templateType()` The type of channel that the message template is designed for.
`String`	`templateTypeAsString()` The type of channel that the message template is designed for.
`PushNotificationTemplateResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

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
  - adm
```
public AndroidPushNotificationTemplate adm()
```
    The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    
    Returns:
    
    The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - apns
```
public APNSPushNotificationTemplate apns()
```
    The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    
    Returns:
    
    The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the message template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the message template.
  - baidu
```
public AndroidPushNotificationTemplate baidu()
```
    The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    
    Returns:
    
    The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - creationDate
```
public String creationDate()
```
    The date, in ISO 8601 format, when the message template was created.
    
    Returns:
    
    The date, in ISO 8601 format, when the message template was created.
  - defaultValue
```
public DefaultPushNotificationTemplate defaultValue()
```
    The default message template that's used for push notification channels.
    
    Returns:
    
    The default message template that's used for push notification channels.
  - defaultSubstitutions
```
public String defaultSubstitutions()
```
    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
    
    Returns:
    
    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
  - gcm
```
public AndroidPushNotificationTemplate gcm()
```
    The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
    
    Returns:
    
    The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
  - lastModifiedDate
```
public String lastModifiedDate()
```
    The date, in ISO 8601 format, when the message template was last modified.
    
    Returns:
    
    The date, in ISO 8601 format, when the message template was last modified.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
  - templateDescription
```
public String templateDescription()
```
    The custom description of the message template.
    
    Returns:
    
    The custom description of the message template.
  - templateName
```
public String templateName()
```
    The name of the message template.
    
    Returns:
    
    The name of the message template.
  - templateType
```
public TemplateType templateType()
```
    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
    
    If the service returns an enum value that is not available in the current SDK version, templateType will return TemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().
    
    Returns:
    
    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
    
    See Also:
    
    TemplateType
  - templateTypeAsString
```
public String templateTypeAsString()
```
    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
    
    If the service returns an enum value that is not available in the current SDK version, templateType will return TemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().
    
    Returns:
    
    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
    
    See Also:
    
    TemplateType
  - version
```
public String version()
```
    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
    
    Returns:
    
    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
  - toBuilder
```
public PushNotificationTemplateResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PushNotificationTemplateResponse.Builder,PushNotificationTemplateResponse>
  - builder
```
public static PushNotificationTemplateResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PushNotificationTemplateResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PushNotificationTemplateResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

adm

apns

arn

baidu

creationDate

defaultValue

defaultSubstitutions

gcm

lastModifiedDate

hasTags

tags

templateDescription

templateName

templateType

templateTypeAsString

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields