com.amazonaws.services.sns.model

Class SetPlatformApplicationAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SetPlatformApplicationAttributesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetPlatformApplicationAttributesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SetPlatformApplicationAttributes operation.

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .

See Also:

AmazonSNS.setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetPlatformApplicationAttributesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetPlatformApplicationAttributesRequest	addAttributesEntry(String key, String value) A map of the platform application attributes.
SetPlatformApplicationAttributesRequest	clearAttributesEntries() Removes all the entries added into Attributes.
SetPlatformApplicationAttributesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Map<String,String>	getAttributes() A map of the platform application attributes.
String	getPlatformApplicationArn() PlatformApplicationArn for SetPlatformApplicationAttributes action.
int	hashCode()
void	setAttributes(Map<String,String> attributes) A map of the platform application attributes.
void	setPlatformApplicationArn(String platformApplicationArn) PlatformApplicationArn for SetPlatformApplicationAttributes action.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetPlatformApplicationAttributesRequest	withAttributes(Map<String,String> attributes) A map of the platform application attributes.
SetPlatformApplicationAttributesRequest	withPlatformApplicationArn(String platformApplicationArn) PlatformApplicationArn for SetPlatformApplicationAttributes action.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SetPlatformApplicationAttributesRequest

public SetPlatformApplicationAttributesRequest()

Method Detail

getPlatformApplicationArn

public String getPlatformApplicationArn()

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Returns:

PlatformApplicationArn for SetPlatformApplicationAttributes action.

setPlatformApplicationArn

public void setPlatformApplicationArn(String platformApplicationArn)

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Parameters:

platformApplicationArn - PlatformApplicationArn for SetPlatformApplicationAttributes action.

withPlatformApplicationArn

public SetPlatformApplicationAttributesRequest withPlatformApplicationArn(String platformApplicationArn)

PlatformApplicationArn for SetPlatformApplicationAttributes action.

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

Parameters:

platformApplicationArn - PlatformApplicationArn for SetPlatformApplicationAttributes action.

Returns:

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

getAttributes

public Map<String,String> getAttributes()

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Returns:

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

setAttributes

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

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Parameters:

attributes - A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

withAttributes

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

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

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

Parameters:

attributes - A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Returns:

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

addAttributesEntry

public SetPlatformApplicationAttributesRequest addAttributesEntry(String key,
                                                         String value)

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential -- The credential 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".
• PlatformPrincipal -- The principal 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".
• EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
• EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
• EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
• EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

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.

clearAttributesEntries

public SetPlatformApplicationAttributesRequest 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

clone

public SetPlatformApplicationAttributesRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()