Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
 
Container for the parameters to the CreatePlatformEndpoint operation.

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication . The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications .

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu .

 
 public class CreatePlatformEndpointRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
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 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 java.util.Map<String,Stringattributes;

    
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Returns:
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
 
     public String getPlatformApplicationArn() {
         return ;
     }
    
    
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

Parameters:
platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
 
     public void setPlatformApplicationArn(String platformApplicationArn) {
         this. = platformApplicationArn;
     }
    
    
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

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

Parameters:
platformApplicationArn PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
Returns:
A reference to this updated object so that method calls can be chained together.
    public CreatePlatformEndpointRequest withPlatformApplicationArn(String platformApplicationArn) {
        this. = 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 or ADM, the device token equivalent is called the registration ID.

Returns:
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 or ADM, the device token equivalent is called the registration ID.
    public String getToken() {
        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 or ADM, the device token equivalent is called the registration ID.

Parameters:
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 or ADM, the device token equivalent is called the registration ID.
    public void setToken(String token) {
        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 or ADM, the device token equivalent is called the registration ID.

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

Parameters:
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 or ADM, the device token equivalent is called the registration ID.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = 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.

Returns:
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 ;
    }
    
    
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.

Parameters:
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;
    }
    
    
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.

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

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.
    public CreatePlatformEndpointRequest withCustomUserData(String customUserData) {
        this. = customUserData;
        return this;
    }

    
For a list of attributes, see SetEndpointAttributes.

Returns:
For a list of attributes, see SetEndpointAttributes.
    public java.util.Map<String,StringgetAttributes() {
        
        if ( == null) {
             = new java.util.HashMap<String,String>();
        }
        return ;
    }
    
    
For a list of attributes, see SetEndpointAttributes.

Parameters:
attributes For a list of attributes, see SetEndpointAttributes.
    public void setAttributes(java.util.Map<String,Stringattributes) {
        this. = attributes;
    }
    
    
For a list of attributes, see SetEndpointAttributes.

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

Parameters:
attributes For a list of attributes, see SetEndpointAttributes.
Returns:
A reference to this updated object so that method calls can be chained together.
        setAttributes(attributes);
        return this;
    }

    
For a list of attributes, see SetEndpointAttributes.

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.
    if (null == this.) {
      this. = new java.util.HashMap<String,String>();
    }
    if (this..containsKey(key))
      throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
    this..put(keyvalue);
    return this;
  }

  
Removes all the entries added into Attributes.

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

    this. = null;
    return this;
  }
  
    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getPlatformApplicationArn() != nullsb.append("PlatformApplicationArn: " + getPlatformApplicationArn() + ",");
        if (getToken() != nullsb.append("Token: " + getToken() + ",");
        if (getCustomUserData() != nullsb.append("CustomUserData: " + getCustomUserData() + ",");
        if (getAttributes() != nullsb.append("Attributes: " + getAttributes() );
        sb.append("}");
        return sb.toString();
    }
    
    @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 boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof CreatePlatformEndpointRequest == falsereturn false;
        
        if (other.getPlatformApplicationArn() == null ^ this.getPlatformApplicationArn() == nullreturn false;
        if (other.getPlatformApplicationArn() != null && other.getPlatformApplicationArn().equals(this.getPlatformApplicationArn()) == falsereturn false
        if (other.getToken() == null ^ this.getToken() == nullreturn false;
        if (other.getToken() != null && other.getToken().equals(this.getToken()) == falsereturn false
        if (other.getCustomUserData() == null ^ this.getCustomUserData() == nullreturn false;
        if (other.getCustomUserData() != null && other.getCustomUserData().equals(this.getCustomUserData()) == falsereturn false
        if (other.getAttributes() == null ^ this.getAttributes() == nullreturn false;
        if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (CreatePlatformEndpointRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X