/* * Copyright 2018-2023 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; /** *
* CreateLocationSmbRequest *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateLocationSmbRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can
* include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other
* SMB clients in your network can also mount this path.
*
* To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of * its data. For more information, see required permissions for SMB locations. *
*/ private String subdirectory; /** ** Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will * mount. *
** You can't specify an IP version 6 (IPv6) address. *
** Specifies the user name that can mount your SMB file server and has permission to access the files and folders * involved in your transfer. *
** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. *
*/ private String user; /** ** Specifies the Windows domain name that your SMB file server belongs to. *
** For more information, see required permissions for SMB locations. *
*/ private String domain; /** ** Specifies the password of the user who can mount your SMB file server and has permission to access the files and * folders involved in your transfer. *
** For more information, see required permissions for SMB locations. *
*/ private String password; /** ** Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent * by using its Amazon Resource Name (ARN). *
*/ private java.util.List* Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. *
*/ private SmbMountOptions mountOptions; /** ** Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. *
*/ private java.util.List
* Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can
* include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other
* SMB clients in your network can also mount this path.
*
* To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of * its data. For more information, see required permissions for SMB locations. *
* * @param subdirectory * Specifies the name of the share exported by your SMB file server where DataSync will read or write data. * You can include a subdirectory in the share path (for example,/path/to/subdirectory
). Make
* sure that other SMB clients in your network can also mount this path.
* * To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access * all of its data. For more information, see required permissions for SMB locations. */ public void setSubdirectory(String subdirectory) { this.subdirectory = subdirectory; } /** *
* Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can
* include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other
* SMB clients in your network can also mount this path.
*
* To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of * its data. For more information, see required permissions for SMB locations. *
* * @return Specifies the name of the share exported by your SMB file server where DataSync will read or write data. * You can include a subdirectory in the share path (for example,/path/to/subdirectory
). Make
* sure that other SMB clients in your network can also mount this path.
* * To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access * all of its data. For more information, see required permissions for SMB locations. */ public String getSubdirectory() { return this.subdirectory; } /** *
* Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can
* include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other
* SMB clients in your network can also mount this path.
*
* To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of * its data. For more information, see required permissions for SMB locations. *
* * @param subdirectory * Specifies the name of the share exported by your SMB file server where DataSync will read or write data. * You can include a subdirectory in the share path (for example,/path/to/subdirectory
). Make
* sure that other SMB clients in your network can also mount this path.
* * To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access * all of its data. For more information, see required permissions for SMB locations. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withSubdirectory(String subdirectory) { setSubdirectory(subdirectory); return this; } /** *
* Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will * mount. *
** You can't specify an IP version 6 (IPv6) address. *
** You can't specify an IP version 6 (IPv6) address. *
*/ public void setServerHostname(String serverHostname) { this.serverHostname = serverHostname; } /** ** Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will * mount. *
** You can't specify an IP version 6 (IPv6) address. *
** You can't specify an IP version 6 (IPv6) address. *
*/ public String getServerHostname() { return this.serverHostname; } /** ** Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will * mount. *
** You can't specify an IP version 6 (IPv6) address. *
** You can't specify an IP version 6 (IPv6) address. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withServerHostname(String serverHostname) { setServerHostname(serverHostname); return this; } /** ** Specifies the user name that can mount your SMB file server and has permission to access the files and folders * involved in your transfer. *
** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. *
* * @param user * Specifies the user name that can mount your SMB file server and has permission to access the files and * folders involved in your transfer. ** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. */ public void setUser(String user) { this.user = user; } /** *
* Specifies the user name that can mount your SMB file server and has permission to access the files and folders * involved in your transfer. *
** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. *
* * @return Specifies the user name that can mount your SMB file server and has permission to access the files and * folders involved in your transfer. ** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. */ public String getUser() { return this.user; } /** *
* Specifies the user name that can mount your SMB file server and has permission to access the files and folders * involved in your transfer. *
** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. *
* * @param user * Specifies the user name that can mount your SMB file server and has permission to access the files and * folders involved in your transfer. ** For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withUser(String user) { setUser(user); return this; } /** *
* Specifies the Windows domain name that your SMB file server belongs to. *
** For more information, see required permissions for SMB locations. *
* * @param domain * Specifies the Windows domain name that your SMB file server belongs to. ** For more information, see required permissions for SMB locations. */ public void setDomain(String domain) { this.domain = domain; } /** *
* Specifies the Windows domain name that your SMB file server belongs to. *
** For more information, see required permissions for SMB locations. *
* * @return Specifies the Windows domain name that your SMB file server belongs to. ** For more information, see required permissions for SMB locations. */ public String getDomain() { return this.domain; } /** *
* Specifies the Windows domain name that your SMB file server belongs to. *
** For more information, see required permissions for SMB locations. *
* * @param domain * Specifies the Windows domain name that your SMB file server belongs to. ** For more information, see required permissions for SMB locations. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withDomain(String domain) { setDomain(domain); return this; } /** *
* Specifies the password of the user who can mount your SMB file server and has permission to access the files and * folders involved in your transfer. *
** For more information, see required permissions for SMB locations. *
* * @param password * Specifies the password of the user who can mount your SMB file server and has permission to access the * files and folders involved in your transfer. ** For more information, see required permissions for SMB locations. */ public void setPassword(String password) { this.password = password; } /** *
* Specifies the password of the user who can mount your SMB file server and has permission to access the files and * folders involved in your transfer. *
** For more information, see required permissions for SMB locations. *
* * @return Specifies the password of the user who can mount your SMB file server and has permission to access the * files and folders involved in your transfer. ** For more information, see required permissions for SMB locations. */ public String getPassword() { return this.password; } /** *
* Specifies the password of the user who can mount your SMB file server and has permission to access the files and * folders involved in your transfer. *
** For more information, see required permissions for SMB locations. *
* * @param password * Specifies the password of the user who can mount your SMB file server and has permission to access the * files and folders involved in your transfer. ** For more information, see required permissions for SMB locations. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withPassword(String password) { setPassword(password); return this; } /** *
* Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent * by using its Amazon Resource Name (ARN). *
* * @return Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify * an agent by using its Amazon Resource Name (ARN). */ public java.util.List* Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent * by using its Amazon Resource Name (ARN). *
* * @param agentArns * Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an * agent by using its Amazon Resource Name (ARN). */ public void setAgentArns(java.util.Collection* Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent * by using its Amazon Resource Name (ARN). *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setAgentArns(java.util.Collection)} or {@link #withAgentArns(java.util.Collection)} if you want to * override the existing values. *
* * @param agentArns * Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an * agent by using its Amazon Resource Name (ARN). * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withAgentArns(String... agentArns) { if (this.agentArns == null) { setAgentArns(new java.util.ArrayList* Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent * by using its Amazon Resource Name (ARN). *
* * @param agentArns * Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an * agent by using its Amazon Resource Name (ARN). * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withAgentArns(java.util.Collection* Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. *
* * @param mountOptions * Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. */ public void setMountOptions(SmbMountOptions mountOptions) { this.mountOptions = mountOptions; } /** ** Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. *
* * @return Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. */ public SmbMountOptions getMountOptions() { return this.mountOptions; } /** ** Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. *
* * @param mountOptions * Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withMountOptions(SmbMountOptions mountOptions) { setMountOptions(mountOptions); return this; } /** ** Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. *
* * @return Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. */ public java.util.List* Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. *
* * @param tags * Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. */ public void setTags(java.util.Collection* Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. *
** NOTE: 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. *
* * @param tags * Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withTags(TagListEntry... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. *
* * @param tags * Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We * recommend creating at least a name tag for your location. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateLocationSmbRequest withTags(java.util.Collection