Class CreatePlatformEndpointRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.sns.model.CreatePlatformEndpointRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreatePlatformEndpointRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for CreatePlatformEndpoint action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreatePlatformEndpointRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreatePlatformEndpointRequest
addAttributesEntry(String key, String value)
CreatePlatformEndpointRequest
clearAttributesEntries()
Removes all the entries added into Attributes.CreatePlatformEndpointRequest
clone()
Creates a shallow clone of this request.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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setPlatformApplicationArn
public void setPlatformApplicationArn(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.
-
getPlatformApplicationArn
public 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.
-
withPlatformApplicationArn
public CreatePlatformEndpointRequest withPlatformApplicationArn(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setToken
public void setToken(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 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 or ADM, the device token equivalent is called the registration ID.
-
getToken
public 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 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 or ADM, the device token equivalent is called the registration ID.
-
withToken
public CreatePlatformEndpointRequest withToken(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 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 or ADM, the device token equivalent is called the registration ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCustomUserData
public void setCustomUserData(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.
-
getCustomUserData
public 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.
-
withCustomUserData
public CreatePlatformEndpointRequest withCustomUserData(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttributes
public Map<String,String> getAttributes()
For a list of attributes, see SetEndpointAttributes.
- Returns:
- For a list of attributes, see SetEndpointAttributes.
-
setAttributes
public void setAttributes(Map<String,String> attributes)
For a list of attributes, see SetEndpointAttributes.
- Parameters:
attributes
- For a list of attributes, see SetEndpointAttributes.
-
withAttributes
public CreatePlatformEndpointRequest withAttributes(Map<String,String> attributes)
For a list of attributes, see SetEndpointAttributes.
- Parameters:
attributes
- For a list of attributes, see SetEndpointAttributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addAttributesEntry
public CreatePlatformEndpointRequest addAttributesEntry(String key, String value)
-
clearAttributesEntries
public CreatePlatformEndpointRequest clearAttributesEntries()
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreatePlatformEndpointRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-