com.amazonaws.services.sns.model.GetEndpointAttributesResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.sns.model;
import java.io.Serializable;
/**
*
* Response from GetEndpointAttributes of the EndpointArn.
*
*/
public class GetEndpointAttributesResult implements Serializable {
/**
* Attributes 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.
*/
private java.util.Map attributes;
/**
* Attributes 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.
*
* @return Attributes 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.
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new java.util.HashMap();
}
return attributes;
}
/**
* Attributes 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.
*
* @param attributes Attributes 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.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes;
}
/**
* Attributes 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 reference to this object so that method calls can be chained together.
*
* @param attributes Attributes 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public GetEndpointAttributesResult withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Attributes 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.
*
* 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.
*
* @param key The key of the entry to be added into Attributes.
* @param value The corresponding value of the entry to be added into Attributes.
*/
public GetEndpointAttributesResult addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public GetEndpointAttributesResult clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAttributes() != null) sb.append("Attributes: " + getAttributes() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof GetEndpointAttributesResult == false) return false;
GetEndpointAttributesResult other = (GetEndpointAttributesResult)obj;
if (other.getAttributes() == null ^ this.getAttributes() == null) return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false;
return true;
}
}