com.amazonaws.services.sns.model

Class SetEndpointAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SetEndpointAttributesRequest

All Implemented Interfaces:

Serializable

public class SetEndpointAttributesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the SetEndpointAttributes operation.

The SetEndpointAttributes action sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications .

See Also:

AmazonSNS.setEndpointAttributes(SetEndpointAttributesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetEndpointAttributesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetEndpointAttributesRequest	addAttributesEntry(String key, String value) A map of the endpoint attributes.
SetEndpointAttributesRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(Object obj)
Map<String,String>	getAttributes() A map of the endpoint attributes.
String	getEndpointArn() EndpointArn used for SetEndpointAttributes action.
int	hashCode()
void	setAttributes(Map<String,String> attributes) A map of the endpoint attributes.
void	setEndpointArn(String endpointArn) EndpointArn used for SetEndpointAttributes action.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetEndpointAttributesRequest	withAttributes(Map<String,String> attributes) A map of the endpoint attributes.
SetEndpointAttributesRequest	withEndpointArn(String endpointArn) EndpointArn used for SetEndpointAttributes action.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetEndpointAttributesRequest

public SetEndpointAttributesRequest()

Method Detail

getEndpointArn

public String getEndpointArn()

EndpointArn used for SetEndpointAttributes action.

Returns:

EndpointArn used for SetEndpointAttributes action.

setEndpointArn

public void setEndpointArn(String endpointArn)

EndpointArn used for SetEndpointAttributes action.

Parameters:

endpointArn - EndpointArn used for SetEndpointAttributes action.

withEndpointArn

public SetEndpointAttributesRequest withEndpointArn(String endpointArn)

EndpointArn used for SetEndpointAttributes action.

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

Parameters:

endpointArn - EndpointArn used for SetEndpointAttributes 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 endpoint attributes. Attributes in this map include the following:

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Returns:

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

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

setAttributes

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

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

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Parameters:

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

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

withAttributes

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

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

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

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

Parameters:

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

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Returns:

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

addAttributesEntry

public SetEndpointAttributesRequest addAttributesEntry(String key,
                                              String value)

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

• CustomUserData -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
• Enabled -- flag that enables/disables delivery to the endpoint. Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
• Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

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 SetEndpointAttributesRequest 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