com.amazonaws.services.cognitoidp.model.SignUpRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2010-2016 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.cognitoidp.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the request to register a user.
*
*/
public class SignUpRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* The ID of the client associated with the user pool.
*
*/
private String clientId;
/**
*
* A keyed-hash message authentication code (HMAC) calculated using the
* secret key of a user pool client and username plus the client ID in the
* message.
*
*/
private String secretHash;
/**
*
* The user name of the user you wish to register.
*
*/
private String username;
/**
*
* The password of the user you wish to register.
*
*/
private String password;
/**
*
* An array of name-value pairs representing user attributes.
*
*/
private java.util.List userAttributes;
/**
*
* The validation data in the request to register a user.
*
*/
private java.util.List validationData;
/**
*
* The ID of the client associated with the user pool.
*
*
* @param clientId
* The ID of the client associated with the user pool.
*/
public void setClientId(String clientId) {
this.clientId = clientId;
}
/**
*
* The ID of the client associated with the user pool.
*
*
* @return The ID of the client associated with the user pool.
*/
public String getClientId() {
return this.clientId;
}
/**
*
* The ID of the client associated with the user pool.
*
*
* @param clientId
* The ID of the client associated with the user pool.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withClientId(String clientId) {
setClientId(clientId);
return this;
}
/**
*
* A keyed-hash message authentication code (HMAC) calculated using the
* secret key of a user pool client and username plus the client ID in the
* message.
*
*
* @param secretHash
* A keyed-hash message authentication code (HMAC) calculated using
* the secret key of a user pool client and username plus the client
* ID in the message.
*/
public void setSecretHash(String secretHash) {
this.secretHash = secretHash;
}
/**
*
* A keyed-hash message authentication code (HMAC) calculated using the
* secret key of a user pool client and username plus the client ID in the
* message.
*
*
* @return A keyed-hash message authentication code (HMAC) calculated using
* the secret key of a user pool client and username plus the client
* ID in the message.
*/
public String getSecretHash() {
return this.secretHash;
}
/**
*
* A keyed-hash message authentication code (HMAC) calculated using the
* secret key of a user pool client and username plus the client ID in the
* message.
*
*
* @param secretHash
* A keyed-hash message authentication code (HMAC) calculated using
* the secret key of a user pool client and username plus the client
* ID in the message.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withSecretHash(String secretHash) {
setSecretHash(secretHash);
return this;
}
/**
*
* The user name of the user you wish to register.
*
*
* @param username
* The user name of the user you wish to register.
*/
public void setUsername(String username) {
this.username = username;
}
/**
*
* The user name of the user you wish to register.
*
*
* @return The user name of the user you wish to register.
*/
public String getUsername() {
return this.username;
}
/**
*
* The user name of the user you wish to register.
*
*
* @param username
* The user name of the user you wish to register.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* The password of the user you wish to register.
*
*
* @param password
* The password of the user you wish to register.
*/
public void setPassword(String password) {
this.password = password;
}
/**
*
* The password of the user you wish to register.
*
*
* @return The password of the user you wish to register.
*/
public String getPassword() {
return this.password;
}
/**
*
* The password of the user you wish to register.
*
*
* @param password
* The password of the user you wish to register.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withPassword(String password) {
setPassword(password);
return this;
}
/**
*
* An array of name-value pairs representing user attributes.
*
*
* @return An array of name-value pairs representing user attributes.
*/
public java.util.List getUserAttributes() {
return userAttributes;
}
/**
*
* An array of name-value pairs representing user attributes.
*
*
* @param userAttributes
* An array of name-value pairs representing user attributes.
*/
public void setUserAttributes(
java.util.Collection userAttributes) {
if (userAttributes == null) {
this.userAttributes = null;
return;
}
this.userAttributes = new java.util.ArrayList(
userAttributes);
}
/**
*
* An array of name-value pairs representing user attributes.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setUserAttributes(java.util.Collection)} or
* {@link #withUserAttributes(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param userAttributes
* An array of name-value pairs representing user attributes.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withUserAttributes(AttributeType... userAttributes) {
if (this.userAttributes == null) {
setUserAttributes(new java.util.ArrayList(
userAttributes.length));
}
for (AttributeType ele : userAttributes) {
this.userAttributes.add(ele);
}
return this;
}
/**
*
* An array of name-value pairs representing user attributes.
*
*
* @param userAttributes
* An array of name-value pairs representing user attributes.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withUserAttributes(
java.util.Collection userAttributes) {
setUserAttributes(userAttributes);
return this;
}
/**
*
* The validation data in the request to register a user.
*
*
* @return The validation data in the request to register a user.
*/
public java.util.List getValidationData() {
return validationData;
}
/**
*
* The validation data in the request to register a user.
*
*
* @param validationData
* The validation data in the request to register a user.
*/
public void setValidationData(
java.util.Collection validationData) {
if (validationData == null) {
this.validationData = null;
return;
}
this.validationData = new java.util.ArrayList(
validationData);
}
/**
*
* The validation data in the request to register a user.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setValidationData(java.util.Collection)} or
* {@link #withValidationData(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param validationData
* The validation data in the request to register a user.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withValidationData(AttributeType... validationData) {
if (this.validationData == null) {
setValidationData(new java.util.ArrayList(
validationData.length));
}
for (AttributeType ele : validationData) {
this.validationData.add(ele);
}
return this;
}
/**
*
* The validation data in the request to register a user.
*
*
* @param validationData
* The validation data in the request to register a user.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public SignUpRequest withValidationData(
java.util.Collection validationData) {
setValidationData(validationData);
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 (getClientId() != null)
sb.append("ClientId: " + getClientId() + ",");
if (getSecretHash() != null)
sb.append("SecretHash: " + getSecretHash() + ",");
if (getUsername() != null)
sb.append("Username: " + getUsername() + ",");
if (getPassword() != null)
sb.append("Password: " + getPassword() + ",");
if (getUserAttributes() != null)
sb.append("UserAttributes: " + getUserAttributes() + ",");
if (getValidationData() != null)
sb.append("ValidationData: " + getValidationData());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SignUpRequest == false)
return false;
SignUpRequest other = (SignUpRequest) obj;
if (other.getClientId() == null ^ this.getClientId() == null)
return false;
if (other.getClientId() != null
&& other.getClientId().equals(this.getClientId()) == false)
return false;
if (other.getSecretHash() == null ^ this.getSecretHash() == null)
return false;
if (other.getSecretHash() != null
&& other.getSecretHash().equals(this.getSecretHash()) == false)
return false;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null
&& other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getPassword() == null ^ this.getPassword() == null)
return false;
if (other.getPassword() != null
&& other.getPassword().equals(this.getPassword()) == false)
return false;
if (other.getUserAttributes() == null
^ this.getUserAttributes() == null)
return false;
if (other.getUserAttributes() != null
&& other.getUserAttributes().equals(this.getUserAttributes()) == false)
return false;
if (other.getValidationData() == null
^ this.getValidationData() == null)
return false;
if (other.getValidationData() != null
&& other.getValidationData().equals(this.getValidationData()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getClientId() == null) ? 0 : getClientId().hashCode());
hashCode = prime * hashCode
+ ((getSecretHash() == null) ? 0 : getSecretHash().hashCode());
hashCode = prime * hashCode
+ ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode
+ ((getPassword() == null) ? 0 : getPassword().hashCode());
hashCode = prime
* hashCode
+ ((getUserAttributes() == null) ? 0 : getUserAttributes()
.hashCode());
hashCode = prime
* hashCode
+ ((getValidationData() == null) ? 0 : getValidationData()
.hashCode());
return hashCode;
}
@Override
public SignUpRequest clone() {
return (SignUpRequest) super.clone();
}
}