com.amazonaws.services.sns.model

Class SetEndpointAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.SetEndpointAttributesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SetEndpointAttributesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Input for SetEndpointAttributes action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetEndpointAttributesRequest()

Method Summary

Modifier and Type	Method and Description
SetEndpointAttributesRequest	addAttributesEntry(String key, String value) Add a single Attributes entry
SetEndpointAttributesRequest	clearAttributesEntries() Removes all the entries added into Attributes.
SetEndpointAttributesRequest	clone()
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.
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

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

SetEndpointAttributesRequest

public SetEndpointAttributesRequest()

Method Detail

setEndpointArn

public void setEndpointArn(String endpointArn)

EndpointArn used for SetEndpointAttributes action.

Parameters:

endpointArn - EndpointArn used for SetEndpointAttributes action.

getEndpointArn

public String getEndpointArn()

EndpointArn used for SetEndpointAttributes action.

Returns:

EndpointArn used for SetEndpointAttributes action.

withEndpointArn

public SetEndpointAttributesRequest withEndpointArn(String endpointArn)

EndpointArn used for SetEndpointAttributes action.

Parameters:

endpointArn - EndpointArn used for SetEndpointAttributes action.

Returns:

Returns a reference to this 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. Amazon 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. Amazon SNS will set this to false when a notification service indicates to Amazon 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. Amazon 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. Amazon SNS will set this to false when a notification service indicates to Amazon 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. Amazon 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. Amazon SNS will set this to false when a notification service indicates to Amazon 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. Amazon 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. Amazon SNS will set this to false when a notification service indicates to Amazon 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. Amazon 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. Amazon SNS will set this to false when a notification service indicates to Amazon 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. Amazon 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. Amazon SNS will set this to false when a notification service indicates to Amazon 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:

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

addAttributesEntry

public SetEndpointAttributesRequest addAttributesEntry(String key,
                                                       String value)

Add a single Attributes entry

See Also:

withAttributes(java.util.Map<java.lang.String, java.lang.String>)

clearAttributesEntries

public SetEndpointAttributesRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SetEndpointAttributesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest