CreateLocationNfsRequest.java

/*
 * Copyright 2014-2019 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.datasync.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * <p>
 * CreateLocationNfsRequest
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationNfs" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateLocationNfsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * <p>
     * The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to
     * the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that
     * path. The path should be such that it can be mounted by other NFS clients in your network.
     * </p>
     * <p>
     * To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an NFS
     * client that has access to your server. You can specify any directory that appears in the results, and any
     * subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.
     * </p>
     * <p>
     * To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To
     * ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for
     * all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read
     * the files. For the agent to access directories, you must additionally enable all execute access.
     * </p>
     * <p>
     * For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat
     * Enterprise Linux documentation.
     * </p>
     */
    private String subdirectory;
    /**
     * <p>
     * The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An
     * agent that is installed on-premises uses this host name to mount the NFS server in a network.
     * </p>
     * <note>
     * <p>
     * This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     * </p>
     * </note>
     */
    private String serverHostname;
    /**
     * <p>
     * Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     * </p>
     */
    private OnPremConfig onPremConfig;
    /**
     * <p>
     * The NFS mount options that DataSync can use to mount your NFS share.
     * </p>
     */
    private NfsMountOptions mountOptions;
    /**
     * <p>
     * The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     * string. We recommend using tags to name your resources.
     * </p>
     */
    private java.util.List<TagListEntry> tags;

    /**
     * <p>
     * The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to
     * the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that
     * path. The path should be such that it can be mounted by other NFS clients in your network.
     * </p>
     * <p>
     * To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an NFS
     * client that has access to your server. You can specify any directory that appears in the results, and any
     * subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.
     * </p>
     * <p>
     * To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To
     * ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for
     * all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read
     * the files. For the agent to access directories, you must additionally enable all execute access.
     * </p>
     * <p>
     * For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat
     * Enterprise Linux documentation.
     * </p>
     * 
     * @param subdirectory
     *        The subdirectory in the NFS file system that is used to read data from the NFS source location or write
     *        data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a
     *        subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your
     *        network. </p>
     *        <p>
     *        To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an
     *        NFS client that has access to your server. You can specify any directory that appears in the results, and
     *        any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos
     *        authentication.
     *        </p>
     *        <p>
     *        To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the
     *        data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the
     *        permissions for all of the files that you want DataSync allow read access for all users. Doing either
     *        enables the agent to read the files. For the agent to access directories, you must additionally enable all
     *        execute access.
     *        </p>
     *        <p>
     *        For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red
     *        Hat Enterprise Linux documentation.
     */

    public void setSubdirectory(String subdirectory) {
        this.subdirectory = subdirectory;
    }

    /**
     * <p>
     * The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to
     * the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that
     * path. The path should be such that it can be mounted by other NFS clients in your network.
     * </p>
     * <p>
     * To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an NFS
     * client that has access to your server. You can specify any directory that appears in the results, and any
     * subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.
     * </p>
     * <p>
     * To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To
     * ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for
     * all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read
     * the files. For the agent to access directories, you must additionally enable all execute access.
     * </p>
     * <p>
     * For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat
     * Enterprise Linux documentation.
     * </p>
     * 
     * @return The subdirectory in the NFS file system that is used to read data from the NFS source location or write
     *         data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a
     *         subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your
     *         network. </p>
     *         <p>
     *         To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an
     *         NFS client that has access to your server. You can specify any directory that appears in the results, and
     *         any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos
     *         authentication.
     *         </p>
     *         <p>
     *         To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the
     *         data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that
     *         the permissions for all of the files that you want DataSync allow read access for all users. Doing either
     *         enables the agent to read the files. For the agent to access directories, you must additionally enable
     *         all execute access.
     *         </p>
     *         <p>
     *         For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red
     *         Hat Enterprise Linux documentation.
     */

    public String getSubdirectory() {
        return this.subdirectory;
    }

    /**
     * <p>
     * The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to
     * the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that
     * path. The path should be such that it can be mounted by other NFS clients in your network.
     * </p>
     * <p>
     * To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an NFS
     * client that has access to your server. You can specify any directory that appears in the results, and any
     * subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.
     * </p>
     * <p>
     * To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To
     * ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for
     * all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read
     * the files. For the agent to access directories, you must additionally enable all execute access.
     * </p>
     * <p>
     * For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat
     * Enterprise Linux documentation.
     * </p>
     * 
     * @param subdirectory
     *        The subdirectory in the NFS file system that is used to read data from the NFS source location or write
     *        data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a
     *        subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your
     *        network. </p>
     *        <p>
     *        To see all the paths exported by your NFS server. run "<code>showmount -e nfs-server-name</code>" from an
     *        NFS client that has access to your server. You can specify any directory that appears in the results, and
     *        any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos
     *        authentication.
     *        </p>
     *        <p>
     *        To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the
     *        data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the
     *        permissions for all of the files that you want DataSync allow read access for all users. Doing either
     *        enables the agent to read the files. For the agent to access directories, you must additionally enable all
     *        execute access.
     *        </p>
     *        <p>
     *        For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red
     *        Hat Enterprise Linux documentation.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CreateLocationNfsRequest withSubdirectory(String subdirectory) {
        setSubdirectory(subdirectory);
        return this;
    }

    /**
     * <p>
     * The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An
     * agent that is installed on-premises uses this host name to mount the NFS server in a network.
     * </p>
     * <note>
     * <p>
     * This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     * </p>
     * </note>
     * 
     * @param serverHostname
     *        The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS
     *        server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.
     *        </p> <note>
     *        <p>
     *        This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     *        </p>
     */

    public void setServerHostname(String serverHostname) {
        this.serverHostname = serverHostname;
    }

    /**
     * <p>
     * The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An
     * agent that is installed on-premises uses this host name to mount the NFS server in a network.
     * </p>
     * <note>
     * <p>
     * This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     * </p>
     * </note>
     * 
     * @return The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS
     *         server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.
     *         </p> <note>
     *         <p>
     *         This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     *         </p>
     */

    public String getServerHostname() {
        return this.serverHostname;
    }

    /**
     * <p>
     * The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An
     * agent that is installed on-premises uses this host name to mount the NFS server in a network.
     * </p>
     * <note>
     * <p>
     * This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     * </p>
     * </note>
     * 
     * @param serverHostname
     *        The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS
     *        server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.
     *        </p> <note>
     *        <p>
     *        This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
     *        </p>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CreateLocationNfsRequest withServerHostname(String serverHostname) {
        setServerHostname(serverHostname);
        return this;
    }

    /**
     * <p>
     * Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     * </p>
     * 
     * @param onPremConfig
     *        Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     */

    public void setOnPremConfig(OnPremConfig onPremConfig) {
        this.onPremConfig = onPremConfig;
    }

    /**
     * <p>
     * Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     * </p>
     * 
     * @return Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     */

    public OnPremConfig getOnPremConfig() {
        return this.onPremConfig;
    }

    /**
     * <p>
     * Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     * </p>
     * 
     * @param onPremConfig
     *        Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CreateLocationNfsRequest withOnPremConfig(OnPremConfig onPremConfig) {
        setOnPremConfig(onPremConfig);
        return this;
    }

    /**
     * <p>
     * The NFS mount options that DataSync can use to mount your NFS share.
     * </p>
     * 
     * @param mountOptions
     *        The NFS mount options that DataSync can use to mount your NFS share.
     */

    public void setMountOptions(NfsMountOptions mountOptions) {
        this.mountOptions = mountOptions;
    }

    /**
     * <p>
     * The NFS mount options that DataSync can use to mount your NFS share.
     * </p>
     * 
     * @return The NFS mount options that DataSync can use to mount your NFS share.
     */

    public NfsMountOptions getMountOptions() {
        return this.mountOptions;
    }

    /**
     * <p>
     * The NFS mount options that DataSync can use to mount your NFS share.
     * </p>
     * 
     * @param mountOptions
     *        The NFS mount options that DataSync can use to mount your NFS share.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CreateLocationNfsRequest withMountOptions(NfsMountOptions mountOptions) {
        setMountOptions(mountOptions);
        return this;
    }

    /**
     * <p>
     * The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     * string. We recommend using tags to name your resources.
     * </p>
     * 
     * @return The key-value pair that represents the tag that you want to add to the location. The value can be an
     *         empty string. We recommend using tags to name your resources.
     */

    public java.util.List<TagListEntry> getTags() {
        return tags;
    }

    /**
     * <p>
     * The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     * string. We recommend using tags to name your resources.
     * </p>
     * 
     * @param tags
     *        The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     *        string. We recommend using tags to name your resources.
     */

    public void setTags(java.util.Collection<TagListEntry> tags) {
        if (tags == null) {
            this.tags = null;
            return;
        }

        this.tags = new java.util.ArrayList<TagListEntry>(tags);
    }

    /**
     * <p>
     * The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     * string. We recommend using tags to name your resources.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
     * existing values.
     * </p>
     * 
     * @param tags
     *        The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     *        string. We recommend using tags to name your resources.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CreateLocationNfsRequest withTags(TagListEntry... tags) {
        if (this.tags == null) {
            setTags(new java.util.ArrayList<TagListEntry>(tags.length));
        }
        for (TagListEntry ele : tags) {
            this.tags.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     * string. We recommend using tags to name your resources.
     * </p>
     * 
     * @param tags
     *        The key-value pair that represents the tag that you want to add to the location. The value can be an empty
     *        string. We recommend using tags to name your resources.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public CreateLocationNfsRequest withTags(java.util.Collection<TagListEntry> tags) {
        setTags(tags);
        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 (getSubdirectory() != null)
            sb.append("Subdirectory: ").append(getSubdirectory()).append(",");
        if (getServerHostname() != null)
            sb.append("ServerHostname: ").append(getServerHostname()).append(",");
        if (getOnPremConfig() != null)
            sb.append("OnPremConfig: ").append(getOnPremConfig()).append(",");
        if (getMountOptions() != null)
            sb.append("MountOptions: ").append(getMountOptions()).append(",");
        if (getTags() != null)
            sb.append("Tags: ").append(getTags());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof CreateLocationNfsRequest == false)
            return false;
        CreateLocationNfsRequest other = (CreateLocationNfsRequest) obj;
        if (other.getSubdirectory() == null ^ this.getSubdirectory() == null)
            return false;
        if (other.getSubdirectory() != null && other.getSubdirectory().equals(this.getSubdirectory()) == false)
            return false;
        if (other.getServerHostname() == null ^ this.getServerHostname() == null)
            return false;
        if (other.getServerHostname() != null && other.getServerHostname().equals(this.getServerHostname()) == false)
            return false;
        if (other.getOnPremConfig() == null ^ this.getOnPremConfig() == null)
            return false;
        if (other.getOnPremConfig() != null && other.getOnPremConfig().equals(this.getOnPremConfig()) == false)
            return false;
        if (other.getMountOptions() == null ^ this.getMountOptions() == null)
            return false;
        if (other.getMountOptions() != null && other.getMountOptions().equals(this.getMountOptions()) == false)
            return false;
        if (other.getTags() == null ^ this.getTags() == null)
            return false;
        if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getSubdirectory() == null) ? 0 : getSubdirectory().hashCode());
        hashCode = prime * hashCode + ((getServerHostname() == null) ? 0 : getServerHostname().hashCode());
        hashCode = prime * hashCode + ((getOnPremConfig() == null) ? 0 : getOnPremConfig().hashCode());
        hashCode = prime * hashCode + ((getMountOptions() == null) ? 0 : getMountOptions().hashCode());
        hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
        return hashCode;
    }

    @Override
    public CreateLocationNfsRequest clone() {
        return (CreateLocationNfsRequest) super.clone();
    }

}