public class CreatePlatformEndpointRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
CreatePlatformEndpoint operation
.
Creates an endpoint for a device and mobile app on one of the
supported push notification services, such as GCM and APNS.
CreatePlatformEndpoint
requires the
PlatformApplicationArn that is returned from
CreatePlatformApplication
. The EndpointArn that is
returned when using CreatePlatformEndpoint
can then be
used by the Publish
action 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
.
Constructor and Description |
---|
CreatePlatformEndpointRequest() |
Modifier and Type | Method and Description |
---|---|
CreatePlatformEndpointRequest |
addAttributesEntry(String key,
String value)
For a list of attributes, see SetEndpointAttributes.
|
CreatePlatformEndpointRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
For a list of attributes, see SetEndpointAttributes.
|
String |
getCustomUserData()
Arbitrary user data to associate with the endpoint.
|
String |
getPlatformApplicationArn()
PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.
|
String |
getToken()
Unique identifier created by the notification service for an app on a
device.
|
int |
hashCode() |
void |
setAttributes(Map<String,String> attributes)
For a list of attributes, see SetEndpointAttributes.
|
void |
setCustomUserData(String customUserData)
Arbitrary user data to associate with the endpoint.
|
void |
setPlatformApplicationArn(String platformApplicationArn)
PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.
|
void |
setToken(String token)
Unique identifier created by the notification service for an app on a
device.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreatePlatformEndpointRequest |
withAttributes(Map<String,String> attributes)
For a list of attributes, see SetEndpointAttributes.
|
CreatePlatformEndpointRequest |
withCustomUserData(String customUserData)
Arbitrary user data to associate with the endpoint.
|
CreatePlatformEndpointRequest |
withPlatformApplicationArn(String platformApplicationArn)
PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.
|
CreatePlatformEndpointRequest |
withToken(String token)
Unique identifier created by the notification service for an app on a
device.
|
copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getPlatformApplicationArn()
public void setPlatformApplicationArn(String platformApplicationArn)
platformApplicationArn
- PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.public CreatePlatformEndpointRequest withPlatformApplicationArn(String platformApplicationArn)
Returns a reference to this object so that method calls can be chained together.
platformApplicationArn
- PlatformApplicationArn returned from CreatePlatformApplication is used
to create a an endpoint.public String getToken()
public void setToken(String token)
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 or ADM, the device token equivalent is called the
registration ID.public CreatePlatformEndpointRequest withToken(String token)
Returns a reference to this object so that method calls can be chained together.
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 or ADM, the device token equivalent is called the
registration ID.public String getCustomUserData()
public void setCustomUserData(String customUserData)
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.public CreatePlatformEndpointRequest withCustomUserData(String customUserData)
Returns a reference to this object so that method calls can be chained together.
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.public Map<String,String> getAttributes()
public void setAttributes(Map<String,String> attributes)
attributes
- For a list of attributes, see SetEndpointAttributes.public CreatePlatformEndpointRequest withAttributes(Map<String,String> attributes)
Returns a reference to this object so that method calls can be chained together.
attributes
- For a list of attributes, see SetEndpointAttributes.public CreatePlatformEndpointRequest addAttributesEntry(String key, String value)
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.
key
- The key of the entry to be added into Attributes.value
- The corresponding value of the entry to be added into Attributes.public CreatePlatformEndpointRequest clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.