public class SetPlatformApplicationAttributesRequest extends AmazonWebServiceRequest implements java.io.Serializable
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. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
Constructor and Description |
---|
SetPlatformApplicationAttributesRequest() |
Modifier and Type | Method and Description |
---|---|
SetPlatformApplicationAttributesRequest |
addAttributesEntry(java.lang.String key,
java.lang.String value)
A map of the platform application attributes.
|
SetPlatformApplicationAttributesRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
boolean |
equals(java.lang.Object obj) |
java.util.Map<java.lang.String,java.lang.String> |
getAttributes()
A map of the platform application attributes.
|
java.lang.String |
getPlatformApplicationArn()
PlatformApplicationArn for SetPlatformApplicationAttributes action.
|
int |
hashCode() |
void |
setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
A map of the platform application attributes.
|
void |
setPlatformApplicationArn(java.lang.String platformApplicationArn)
PlatformApplicationArn for SetPlatformApplicationAttributes action.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SetPlatformApplicationAttributesRequest |
withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
A map of the platform application attributes.
|
SetPlatformApplicationAttributesRequest |
withPlatformApplicationArn(java.lang.String platformApplicationArn)
PlatformApplicationArn for SetPlatformApplicationAttributes action.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public SetPlatformApplicationAttributesRequest()
public java.lang.String getPlatformApplicationArn()
PlatformApplicationArn for SetPlatformApplicationAttributes action.
PlatformApplicationArn for SetPlatformApplicationAttributes action.
public void setPlatformApplicationArn(java.lang.String platformApplicationArn)
PlatformApplicationArn for SetPlatformApplicationAttributes action.
platformApplicationArn
- PlatformApplicationArn for SetPlatformApplicationAttributes action.
public SetPlatformApplicationAttributesRequest withPlatformApplicationArn(java.lang.String platformApplicationArn)
PlatformApplicationArn for SetPlatformApplicationAttributes action.
Returns a reference to this object so that method calls can be chained together.
platformApplicationArn
- PlatformApplicationArn for SetPlatformApplicationAttributes action.
public java.util.Map<java.lang.String,java.lang.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.
SuccessFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage (0-100)
of successfully delivered messages.
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.
SuccessFeedbackRoleArn
-- IAM role ARN used to give
Amazon SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give
Amazon SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage
(0-100) of successfully delivered messages.
public void setAttributes(java.util.Map<java.lang.String,java.lang.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.
SuccessFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage (0-100)
of successfully delivered messages.
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.
SuccessFeedbackRoleArn
-- IAM role ARN used to
give Amazon SNS write access to use CloudWatch Logs on your
behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to
give Amazon SNS write access to use CloudWatch Logs on your
behalf.
SuccessFeedbackSampleRate
-- Sample rate
percentage (0-100) of successfully delivered messages.
public SetPlatformApplicationAttributesRequest withAttributes(java.util.Map<java.lang.String,java.lang.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.
SuccessFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage (0-100)
of successfully delivered messages.
Returns a reference to this object so that method calls can be chained together.
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.
SuccessFeedbackRoleArn
-- IAM role ARN used to
give Amazon SNS write access to use CloudWatch Logs on your
behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to
give Amazon SNS write access to use CloudWatch Logs on your
behalf.
SuccessFeedbackSampleRate
-- Sample rate
percentage (0-100) of successfully delivered messages.
public SetPlatformApplicationAttributesRequest addAttributesEntry(java.lang.String key, java.lang.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.
SuccessFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn
-- IAM role ARN used to give Amazon
SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate
-- Sample rate percentage (0-100)
of successfully delivered messages.
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 SetPlatformApplicationAttributesRequest 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.