public class CreatePlatformApplicationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
CreatePlatformApplication operation
.
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
APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret". 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
.
Constructor and Description |
---|
CreatePlatformApplicationRequest() |
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 GCM (Google
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 GCM (Google
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 GCM (Google
Cloud Messaging).
|
copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getName()
public void setName(String name)
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(String name)
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 String getPlatform()
public void setPlatform(String platform)
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(String platform)
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 Map<String,String> getAttributes()
public void setAttributes(Map<String,String> attributes)
attributes
- For a list of attributes, see SetPlatformApplicationAttributespublic CreatePlatformApplicationRequest 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 SetPlatformApplicationAttributespublic CreatePlatformApplicationRequest 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 CreatePlatformApplicationRequest 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.