Package com.amazonaws.services.sns.model
Class SetEndpointAttributesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.sns.model.SetEndpointAttributesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class SetEndpointAttributesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Input for SetEndpointAttributes action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description SetEndpointAttributesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetEndpointAttributesRequest
addAttributesEntry(String key, String value)
SetEndpointAttributesRequest
clearAttributesEntries()
Removes all the entries added into Attributes.SetEndpointAttributesRequest
clone()
Creates a shallow clone of this request.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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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)
-
clearAttributesEntries
public SetEndpointAttributesRequest clearAttributesEntries()
Removes all the entries added into Attributes. <p> 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public SetEndpointAttributesRequest 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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-