com.amazonaws.services.identitymanagement.model.CreateUserRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi 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.identitymanagement.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 */
public class CreateUserRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.
     * 
     * 
     * This parameter is optional. If it is not included, it defaults to a slash
     * (/).
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of either a forward slash
     * (/) by itself or a string that must begin and end with forward slashes,
     * containing any ASCII character from the ! (\u0021) thru the DEL character
     * (\u007F), including most punctuation characters, digits, and upper and
     * lowercased letters.
     * 
     */
    private String path;
    /**
     * 
     * The name of the user to create.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     */
    private String userName;
    /**
     * Default constructor for CreateUserRequest object. Callers should use the
     * setter or fluent setter (with...) methods to initialize the object after
     * creating it.
     */
    public CreateUserRequest() {
    }
    /**
     * Constructs a new CreateUserRequest object. Callers should use the setter
     * or fluent setter (with...) methods to initialize any additional object
     * members.
     * 
     * @param userName
     *        The name of the user to create.
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of upper
     *        and lowercase alphanumeric characters with no spaces. You can also
     *        include any of the following characters: =,.@-
     */
    public CreateUserRequest(String userName) {
        setUserName(userName);
    }
    /**
     * 
     * The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.
     * 
     * 
     * This parameter is optional. If it is not included, it defaults to a slash
     * (/).
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of either a forward slash
     * (/) by itself or a string that must begin and end with forward slashes,
     * containing any ASCII character from the ! (\u0021) thru the DEL character
     * (\u007F), including most punctuation characters, digits, and upper and
     * lowercased letters.
     * 
     * 
     * @param path
     *        The path for the user name. For more information about paths, see
     *        IAM Identifiers in the IAM User Guide.
     *        
     *        This parameter is optional. If it is not included, it defaults to
     *        a slash (/).
     *        
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of either
     *        a forward slash (/) by itself or a string that must begin and end
     *        with forward slashes, containing any ASCII character from the !
     *        (\u0021) thru the DEL character (\u007F), including most
     *        punctuation characters, digits, and upper and lowercased letters.
     */
    public void setPath(String path) {
        this.path = path;
    }
    /**
     * 
     * The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.
     * 
     * 
     * This parameter is optional. If it is not included, it defaults to a slash
     * (/).
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of either a forward slash
     * (/) by itself or a string that must begin and end with forward slashes,
     * containing any ASCII character from the ! (\u0021) thru the DEL character
     * (\u007F), including most punctuation characters, digits, and upper and
     * lowercased letters.
     * 
     * 
     * @return The path for the user name. For more information about paths, see
     *         IAM Identifiers in the IAM User Guide.
     *         
     *         This parameter is optional. If it is not included, it defaults to
     *         a slash (/).
     *         
     *         
     *         The regex pattern
     *         for this parameter is a string of characters consisting of either
     *         a forward slash (/) by itself or a string that must begin and end
     *         with forward slashes, containing any ASCII character from the !
     *         (\u0021) thru the DEL character (\u007F), including most
     *         punctuation characters, digits, and upper and lowercased letters.
     */
    public String getPath() {
        return this.path;
    }
    /**
     * 
     * The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.
     * 
     * 
     * This parameter is optional. If it is not included, it defaults to a slash
     * (/).
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of either a forward slash
     * (/) by itself or a string that must begin and end with forward slashes,
     * containing any ASCII character from the ! (\u0021) thru the DEL character
     * (\u007F), including most punctuation characters, digits, and upper and
     * lowercased letters.
     * 
     * 
     * @param path
     *        The path for the user name. For more information about paths, see
     *        IAM Identifiers in the IAM User Guide.
     *        
     *        This parameter is optional. If it is not included, it defaults to
     *        a slash (/).
     *        
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of either
     *        a forward slash (/) by itself or a string that must begin and end
     *        with forward slashes, containing any ASCII character from the !
     *        (\u0021) thru the DEL character (\u007F), including most
     *        punctuation characters, digits, and upper and lowercased letters.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateUserRequest withPath(String path) {
        setPath(path);
        return this;
    }
    /**
     * 
     * The name of the user to create.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     * 
     * @param userName
     *        The name of the user to create.
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of upper
     *        and lowercase alphanumeric characters with no spaces. You can also
     *        include any of the following characters: =,.@-
     */
    public void setUserName(String userName) {
        this.userName = userName;
    }
    /**
     * 
     * The name of the user to create.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     * 
     * @return The name of the user to create.
     *         
     *         The regex pattern
     *         for this parameter is a string of characters consisting of upper
     *         and lowercase alphanumeric characters with no spaces. You can
     *         also include any of the following characters: =,.@-
     */
    public String getUserName() {
        return this.userName;
    }
    /**
     * 
     * The name of the user to create.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     * 
     * @param userName
     *        The name of the user to create.
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of upper
     *        and lowercase alphanumeric characters with no spaces. You can also
     *        include any of the following characters: =,.@-
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateUserRequest withUserName(String userName) {
        setUserName(userName);
        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 (getPath() != null)
            sb.append("Path: " + getPath() + ",");
        if (getUserName() != null)
            sb.append("UserName: " + getUserName());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof CreateUserRequest == false)
            return false;
        CreateUserRequest other = (CreateUserRequest) obj;
        if (other.getPath() == null ^ this.getPath() == null)
            return false;
        if (other.getPath() != null
                && other.getPath().equals(this.getPath()) == false)
            return false;
        if (other.getUserName() == null ^ this.getUserName() == null)
            return false;
        if (other.getUserName() != null
                && other.getUserName().equals(this.getUserName()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getPath() == null) ? 0 : getPath().hashCode());
        hashCode = prime * hashCode
                + ((getUserName() == null) ? 0 : getUserName().hashCode());
        return hashCode;
    }
    @Override
    public CreateUserRequest clone() {
        return (CreateUserRequest) super.clone();
    }
}