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, 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 GCM,
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 GCM,
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. For more information, see Using
Amazon SNS Mobile Push Notifications. For more information about
obtaining the PlatformPrincipal and PlatformCredential for each of the
supported push notification services, see Getting
Started with Apple Push Notification Service, Getting
Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting
Started with Google Cloud Messaging for Android, Getting
Started with MPNS, or Getting
Started with WNS.
Constructor and Description |
---|
CreatePlatformApplicationRequest() |
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 (Google
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 (Google
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 (Google
Cloud Messaging).
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
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.
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.
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.
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.
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.
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.
public java.lang.String getPlatform()
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
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 (Google Cloud Messaging).
platform
- The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
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 (Google Cloud Messaging).
Returns a reference to this object so that method calls can be chained together.
platform
- The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
For a list of attributes, see SetPlatformApplicationAttributes
For a list of attributes, see SetPlatformApplicationAttributes
public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
For a list of attributes, see SetPlatformApplicationAttributes
attributes
- For a list of attributes, see SetPlatformApplicationAttributes
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.
attributes
- For a list of attributes, see SetPlatformApplicationAttributes
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.
key
- The key of the entry to be added into Attributes.value
- The corresponding value of the entry to be added into
Attributes.public CreatePlatformApplicationRequest clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.