com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceRequest 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 CreateVirtualMFADeviceRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * The path for the virtual MFA device. 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 virtual MFA device. Use with path to uniquely identify a
     * virtual MFA device.
     * 
     * 
     * 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 virtualMFADeviceName;
    /**
     * 
     * The path for the virtual MFA device. 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 virtual MFA device. 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 virtual MFA device. 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 virtual MFA device. 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 virtual MFA device. 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 virtual MFA device. 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 CreateVirtualMFADeviceRequest withPath(String path) {
        setPath(path);
        return this;
    }
    /**
     * 
     * The name of the virtual MFA device. Use with path to uniquely identify a
     * virtual MFA device.
     * 
     * 
     * 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 virtualMFADeviceName
     *        The name of the virtual MFA device. Use with path to uniquely
     *        identify a virtual MFA device.
     *        
     *        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 setVirtualMFADeviceName(String virtualMFADeviceName) {
        this.virtualMFADeviceName = virtualMFADeviceName;
    }
    /**
     * 
     * The name of the virtual MFA device. Use with path to uniquely identify a
     * virtual MFA device.
     * 
     * 
     * 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 virtual MFA device. Use with path to uniquely
     *         identify a virtual MFA device.
     *         
     *         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 getVirtualMFADeviceName() {
        return this.virtualMFADeviceName;
    }
    /**
     * 
     * The name of the virtual MFA device. Use with path to uniquely identify a
     * virtual MFA device.
     * 
     * 
     * 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 virtualMFADeviceName
     *        The name of the virtual MFA device. Use with path to uniquely
     *        identify a virtual MFA device.
     *        
     *        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 CreateVirtualMFADeviceRequest withVirtualMFADeviceName(
            String virtualMFADeviceName) {
        setVirtualMFADeviceName(virtualMFADeviceName);
        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 (getVirtualMFADeviceName() != null)
            sb.append("VirtualMFADeviceName: " + getVirtualMFADeviceName());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof CreateVirtualMFADeviceRequest == false)
            return false;
        CreateVirtualMFADeviceRequest other = (CreateVirtualMFADeviceRequest) obj;
        if (other.getPath() == null ^ this.getPath() == null)
            return false;
        if (other.getPath() != null
                && other.getPath().equals(this.getPath()) == false)
            return false;
        if (other.getVirtualMFADeviceName() == null
                ^ this.getVirtualMFADeviceName() == null)
            return false;
        if (other.getVirtualMFADeviceName() != null
                && other.getVirtualMFADeviceName().equals(
                        this.getVirtualMFADeviceName()) == 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
                + ((getVirtualMFADeviceName() == null) ? 0
                        : getVirtualMFADeviceName().hashCode());
        return hashCode;
    }
    @Override
    public CreateVirtualMFADeviceRequest clone() {
        return (CreateVirtualMFADeviceRequest) super.clone();
    }
}