com.amazonaws.services.sns.model

Class CreatePlatformApplicationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.CreatePlatformApplicationRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreatePlatformApplicationRequest
extends AmazonWebServiceRequest
implements Serializable

Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".

For APNS/APNS_SANDBOX, PlatformCredential is "private key". For FCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreatePlatformApplicationRequest()

Method Summary

Modifier and Type	Method and Description
CreatePlatformApplicationRequest	addAttributesEntry(String key, String value) For a list of attributes, see SetPlatformApplicationAttributes
CreatePlatformApplicationRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(Object obj)
Map<String,String>	getAttributes() For a list of attributes, see SetPlatformApplicationAttributes
String	getName() Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
String	getPlatform() The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).
int	hashCode()
void	setAttributes(Map<String,String> attributes) For a list of attributes, see SetPlatformApplicationAttributes
void	setName(String name) Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
void	setPlatform(String platform) The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePlatformApplicationRequest	withAttributes(Map<String,String> attributes) For a list of attributes, see SetPlatformApplicationAttributes
CreatePlatformApplicationRequest	withName(String name) Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
CreatePlatformApplicationRequest	withPlatform(String platform) The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePlatformApplicationRequest

public CreatePlatformApplicationRequest()

Method Detail

getName

public String getName()

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

Returns:

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

setName

public void setName(String name)

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

Parameters:

name -

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

withName

public CreatePlatformApplicationRequest withName(String name)

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

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

Parameters:

name -

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

Returns:

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

getPlatform

public String getPlatform()

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

Returns:

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

setPlatform

public void setPlatform(String platform)

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

Parameters:

platform -

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

withPlatform

public CreatePlatformApplicationRequest withPlatform(String platform)

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

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

Parameters:

platform -

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

Returns:

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

getAttributes

public Map<String,String> getAttributes()

For a list of attributes, see SetPlatformApplicationAttributes

Returns:

For a list of attributes, see SetPlatformApplicationAttributes

setAttributes

public void setAttributes(Map<String,String> attributes)

For a list of attributes, see SetPlatformApplicationAttributes

Parameters:

attributes -

For a list of attributes, see SetPlatformApplicationAttributes

withAttributes

public CreatePlatformApplicationRequest withAttributes(Map<String,String> attributes)

For a list of attributes, see SetPlatformApplicationAttributes

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

Parameters:

attributes -

For a list of attributes, see SetPlatformApplicationAttributes

Returns:

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

addAttributesEntry

public CreatePlatformApplicationRequest addAttributesEntry(String key,
                                                           String value)

For a list of attributes, see SetPlatformApplicationAttributes

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 CreatePlatformApplicationRequest clearAttributesEntries()

Removes all the entries added into Attributes.

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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object