com.amazonaws.services.sns.model

Class CreatePlatformEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.CreatePlatformEndpointRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreatePlatformEndpointRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreatePlatformEndpointRequest()

Method Summary

Modifier and Type	Method and Description
CreatePlatformEndpointRequest	addAttributesEntry(java.lang.String key, java.lang.String value) For a list of attributes, see SetEndpointAttributes.
CreatePlatformEndpointRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() For a list of attributes, see SetEndpointAttributes.
java.lang.String	getCustomUserData() Arbitrary user data to associate with the endpoint.
java.lang.String	getPlatformApplicationArn() PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
java.lang.String	getToken() Unique identifier created by the notification service for an app on a device.
int	hashCode()
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) For a list of attributes, see SetEndpointAttributes.
void	setCustomUserData(java.lang.String customUserData) Arbitrary user data to associate with the endpoint.
void	setPlatformApplicationArn(java.lang.String platformApplicationArn) PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
void	setToken(java.lang.String token) Unique identifier created by the notification service for an app on a device.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePlatformEndpointRequest	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) For a list of attributes, see SetEndpointAttributes.
CreatePlatformEndpointRequest	withCustomUserData(java.lang.String customUserData) Arbitrary user data to associate with the endpoint.
CreatePlatformEndpointRequest	withPlatformApplicationArn(java.lang.String platformApplicationArn) PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
CreatePlatformEndpointRequest	withToken(java.lang.String token) Unique identifier created by the notification service for an app on a device.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePlatformEndpointRequest

public CreatePlatformEndpointRequest()

Method Detail

getPlatformApplicationArn

public java.lang.String getPlatformApplicationArn()

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Returns:

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

setPlatformApplicationArn

public void setPlatformApplicationArn(java.lang.String platformApplicationArn)

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Parameters:

platformApplicationArn -

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

withPlatformApplicationArn

public CreatePlatformEndpointRequest withPlatformApplicationArn(java.lang.String platformApplicationArn)

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Returns a reference to this object so that method calls can be chained together.

Parameters:

platformApplicationArn -

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

getToken

public java.lang.String getToken()

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Returns:

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

setToken

public void setToken(java.lang.String token)

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Parameters:

token -

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

withToken

public CreatePlatformEndpointRequest withToken(java.lang.String token)

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Returns a reference to this object so that method calls can be chained together.

Parameters:

token -

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getCustomUserData

public java.lang.String getCustomUserData()

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

Returns:

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

setCustomUserData

public void setCustomUserData(java.lang.String customUserData)

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

Parameters:

customUserData -

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

withCustomUserData

public CreatePlatformEndpointRequest withCustomUserData(java.lang.String customUserData)

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

Returns a reference to this object so that method calls can be chained together.

Parameters:

customUserData -

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

For a list of attributes, see SetEndpointAttributes.

Returns:

For a list of attributes, see SetEndpointAttributes.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

For a list of attributes, see SetEndpointAttributes.

Parameters:

attributes -

For a list of attributes, see SetEndpointAttributes.

withAttributes

public CreatePlatformEndpointRequest withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

For a list of attributes, see SetEndpointAttributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

attributes -

For a list of attributes, see SetEndpointAttributes.

Returns:

A reference to this updated object so that method calls can be chained together.

addAttributesEntry

public CreatePlatformEndpointRequest addAttributesEntry(java.lang.String key,
                                                        java.lang.String value)

For a list of attributes, see SetEndpointAttributes.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAttributesEntries

public CreatePlatformEndpointRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns a reference to this object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object