com.amazonaws.services.datasync.model

Class CreateLocationSmbRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.CreateLocationSmbRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateLocationSmbRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

CreateLocationSmbRequest

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateLocationSmbRequest()

Method Summary

Modifier and Type	Method and Description
CreateLocationSmbRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAgentArns() Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.
String	getDomain() Specifies the name of the Active Directory domain that your SMB file server belongs to.
SmbMountOptions	getMountOptions() Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
String	getPassword() 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.
String	getServerHostname() Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
String	getSubdirectory() Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
List<TagListEntry>	getTags() Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
String	getUser() Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.
int	hashCode()
void	setAgentArns(Collection<String> agentArns) Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.
void	setDomain(String domain) Specifies the name of the Active Directory domain that your SMB file server belongs to.
void	setMountOptions(SmbMountOptions mountOptions) Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
void	setPassword(String 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.
void	setServerHostname(String serverHostname) Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
void	setSubdirectory(String subdirectory) Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
void	setTags(Collection<TagListEntry> tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
void	setUser(String user) Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.
String	toString() Returns a string representation of this object.
CreateLocationSmbRequest	withAgentArns(Collection<String> agentArns) Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.
CreateLocationSmbRequest	withAgentArns(String... agentArns) Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.
CreateLocationSmbRequest	withDomain(String domain) Specifies the name of the Active Directory domain that your SMB file server belongs to.
CreateLocationSmbRequest	withMountOptions(SmbMountOptions mountOptions) Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
CreateLocationSmbRequest	withPassword(String 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.
CreateLocationSmbRequest	withServerHostname(String serverHostname) Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
CreateLocationSmbRequest	withSubdirectory(String subdirectory) Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
CreateLocationSmbRequest	withTags(Collection<TagListEntry> tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
CreateLocationSmbRequest	withTags(TagListEntry... tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
CreateLocationSmbRequest	withUser(String user) Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateLocationSmbRequest

public CreateLocationSmbRequest()

Method Detail

setSubdirectory

public void setSubdirectory(String 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 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.

Parameters:

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 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.

getSubdirectory

public String getSubdirectory()

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 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.

Returns:

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 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.

withSubdirectory

public CreateLocationSmbRequest withSubdirectory(String 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 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.

Parameters:

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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setServerHostname

public void setServerHostname(String 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.

Parameters:

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.

getServerHostname

public String getServerHostname()

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.

Returns:

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.

withServerHostname

public CreateLocationSmbRequest withServerHostname(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUser

public void setUser(String user)

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

Parameters:

user - Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

getUser

public String getUser()

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

Returns:

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

withUser

public CreateLocationSmbRequest withUser(String user)

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

Parameters:

user - Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDomain

public void setDomain(String domain)

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Parameters:

domain - Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

getDomain

public String getDomain()

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Returns:

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

withDomain

public CreateLocationSmbRequest withDomain(String domain)

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Parameters:

domain - Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPassword

public void setPassword(String 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.

Parameters:

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.

getPassword

public String getPassword()

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.

Returns:

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.

withPassword

public CreateLocationSmbRequest withPassword(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAgentArns

public List<String> getAgentArns()

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).

Returns:

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).

setAgentArns

public void setAgentArns(Collection<String> 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).

Parameters:

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).

withAgentArns

public CreateLocationSmbRequest withAgentArns(String... 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).

NOTE: This method appends the values to the existing list (if any). Use setAgentArns(java.util.Collection) or withAgentArns(java.util.Collection) if you want to override the existing values.

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

withAgentArns

public CreateLocationSmbRequest withAgentArns(Collection<String> 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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

setMountOptions

public void setMountOptions(SmbMountOptions mountOptions)

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Parameters:

mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

getMountOptions

public SmbMountOptions getMountOptions()

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Returns:

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

withMountOptions

public CreateLocationSmbRequest withMountOptions(SmbMountOptions mountOptions)

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Parameters:

mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<TagListEntry> getTags()

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.

Returns:

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.

setTags

public void setTags(Collection<TagListEntry> 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.

Parameters:

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.

withTags

public CreateLocationSmbRequest withTags(TagListEntry... 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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateLocationSmbRequest withTags(Collection<TagListEntry> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateLocationSmbRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()