com.amazonaws.services.sns.model

Class CreatePlatformApplicationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.CreatePlatformApplicationRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreatePlatformApplicationRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

• For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

• For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

• For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

• For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

• For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

• For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn 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(java.lang.String key, java.lang.String value) For a list of attributes, see SetPlatformApplicationAttributes
CreatePlatformApplicationRequest	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 SetPlatformApplicationAttributes
java.lang.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.
java.lang.String	getPlatform() The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
int	hashCode()
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) For a list of attributes, see SetPlatformApplicationAttributes
void	setName(java.lang.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(java.lang.String platform) The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePlatformApplicationRequest	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) For a list of attributes, see SetPlatformApplicationAttributes
CreatePlatformApplicationRequest	withName(java.lang.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(java.lang.String platform) The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

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

CreatePlatformApplicationRequest

public CreatePlatformApplicationRequest()

Method Detail

getName

public java.lang.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(java.lang.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(java.lang.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 java.lang.String getPlatform()

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

Returns:

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

setPlatform

public void setPlatform(java.lang.String platform)

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

Parameters:

platform -

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

withPlatform

public CreatePlatformApplicationRequest withPlatform(java.lang.String platform)

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (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 GCM (Firebase Cloud Messaging).

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 SetPlatformApplicationAttributes

Returns:

For a list of attributes, see SetPlatformApplicationAttributes

setAttributes

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

For a list of attributes, see SetPlatformApplicationAttributes

Parameters:

attributes -

For a list of attributes, see SetPlatformApplicationAttributes

withAttributes

public CreatePlatformApplicationRequest withAttributes(java.util.Map<java.lang.String,java.lang.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(java.lang.String key,
                                                           java.lang.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 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