com.amazonaws.services.sns.model.CreatePlatformEndpointRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Input for CreatePlatformEndpoint action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreatePlatformEndpointRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
*
*/
private String platformApplicationArn;
/**
*
* Unique identifier created by the notification service for an app on a device. The specific name for Token will
* vary, depending on which notification service is being used. For example, when using APNS as the notification
* service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device
* token equivalent is called the registration ID.
*
*/
private String token;
/**
*
* 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.
*
*/
private String customUserData;
/**
*
* For a list of attributes, see
* SetEndpointAttributes .
*
*/
private com.amazonaws.internal.SdkInternalMap attributes;
/**
*
* PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
*
*
* @param platformApplicationArn
* PlatformApplicationArn returned from CreatePlatformApplication is used to create a an
* endpoint.
*/
public void setPlatformApplicationArn(String platformApplicationArn) {
this.platformApplicationArn = platformApplicationArn;
}
/**
*
* PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
*
*
* @return PlatformApplicationArn returned from CreatePlatformApplication is used to create a an
* endpoint.
*/
public String getPlatformApplicationArn() {
return this.platformApplicationArn;
}
/**
*
* PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
*
*
* @param platformApplicationArn
* PlatformApplicationArn returned from CreatePlatformApplication is used to create a an
* endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlatformEndpointRequest withPlatformApplicationArn(String platformApplicationArn) {
setPlatformApplicationArn(platformApplicationArn);
return this;
}
/**
*
* Unique identifier created by the notification service for an app on a device. The specific name for Token will
* vary, depending on which notification service is being used. For example, when using APNS as the notification
* service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device
* token equivalent is called the registration ID.
*
*
* @param token
* Unique identifier created by the notification service for an app on a device. The specific name for Token
* will vary, depending on which notification service is being used. For example, when using APNS as the
* notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging)
* or ADM, the device token equivalent is called the registration ID.
*/
public void setToken(String token) {
this.token = token;
}
/**
*
* Unique identifier created by the notification service for an app on a device. The specific name for Token will
* vary, depending on which notification service is being used. For example, when using APNS as the notification
* service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device
* token equivalent is called the registration ID.
*
*
* @return Unique identifier created by the notification service for an app on a device. The specific name for Token
* will vary, depending on which notification service is being used. For example, when using APNS as the
* notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging)
* or ADM, the device token equivalent is called the registration ID.
*/
public String getToken() {
return this.token;
}
/**
*
* Unique identifier created by the notification service for an app on a device. The specific name for Token will
* vary, depending on which notification service is being used. For example, when using APNS as the notification
* service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device
* token equivalent is called the registration ID.
*
*
* @param token
* Unique identifier created by the notification service for an app on a device. The specific name for Token
* will vary, depending on which notification service is being used. For example, when using APNS as the
* notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging)
* or ADM, the device token equivalent is called the registration ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlatformEndpointRequest withToken(String token) {
setToken(token);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setCustomUserData(String customUserData) {
this.customUserData = 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.
*
*
* @return 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.
*/
public String getCustomUserData() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlatformEndpointRequest withCustomUserData(String customUserData) {
setCustomUserData(customUserData);
return this;
}
/**
*
* For a list of attributes, see
* SetEndpointAttributes .
*
*
* @return For a list of attributes, see
* SetEndpointAttributes .
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new com.amazonaws.internal.SdkInternalMap();
}
return attributes;
}
/**
*
* For a list of attributes, see
* SetEndpointAttributes .
*
*
* @param attributes
* For a list of attributes, see
* SetEndpointAttributes .
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes == null ? null : new com.amazonaws.internal.SdkInternalMap(attributes);
}
/**
*
* For a list of attributes, see
* SetEndpointAttributes .
*
*
* @param attributes
* For a list of attributes, see
* SetEndpointAttributes .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlatformEndpointRequest withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see CreatePlatformEndpointRequest#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public CreatePlatformEndpointRequest addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new com.amazonaws.internal.SdkInternalMap();
}
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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePlatformEndpointRequest clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPlatformApplicationArn() != null)
sb.append("PlatformApplicationArn: ").append(getPlatformApplicationArn()).append(",");
if (getToken() != null)
sb.append("Token: ").append(getToken()).append(",");
if (getCustomUserData() != null)
sb.append("CustomUserData: ").append(getCustomUserData()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreatePlatformEndpointRequest == false)
return false;
CreatePlatformEndpointRequest other = (CreatePlatformEndpointRequest) obj;
if (other.getPlatformApplicationArn() == null ^ this.getPlatformApplicationArn() == null)
return false;
if (other.getPlatformApplicationArn() != null && other.getPlatformApplicationArn().equals(this.getPlatformApplicationArn()) == false)
return false;
if (other.getToken() == null ^ this.getToken() == null)
return false;
if (other.getToken() != null && other.getToken().equals(this.getToken()) == false)
return false;
if (other.getCustomUserData() == null ^ this.getCustomUserData() == null)
return false;
if (other.getCustomUserData() != null && other.getCustomUserData().equals(this.getCustomUserData()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPlatformApplicationArn() == null) ? 0 : getPlatformApplicationArn().hashCode());
hashCode = prime * hashCode + ((getToken() == null) ? 0 : getToken().hashCode());
hashCode = prime * hashCode + ((getCustomUserData() == null) ? 0 : getCustomUserData().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
return hashCode;
}
@Override
public CreatePlatformEndpointRequest clone() {
return (CreatePlatformEndpointRequest) super.clone();
}
}