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() The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
String	getDomain() The name of the Windows domain that the SMB server belongs to.
SmbMountOptions	getMountOptions() The mount options used by DataSync to access the SMB server.
String	getPassword() The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
String	getServerHostname() The name of the SMB server.
String	getSubdirectory() The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.
List<TagListEntry>	getTags() The key-value pair that represents the tag that you want to add to the location.
String	getUser() The user who can mount the share, has the permissions to access files and folders in the SMB share.
int	hashCode()
void	setAgentArns(Collection<String> agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
void	setDomain(String domain) The name of the Windows domain that the SMB server belongs to.
void	setMountOptions(SmbMountOptions mountOptions) The mount options used by DataSync to access the SMB server.
void	setPassword(String password) The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
void	setServerHostname(String serverHostname) The name of the SMB server.
void	setSubdirectory(String subdirectory) The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.
void	setTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the location.
void	setUser(String user) The user who can mount the share, has the permissions to access files and folders in the SMB share.
String	toString() Returns a string representation of this object.
CreateLocationSmbRequest	withAgentArns(Collection<String> agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
CreateLocationSmbRequest	withAgentArns(String... agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
CreateLocationSmbRequest	withDomain(String domain) The name of the Windows domain that the SMB server belongs to.
CreateLocationSmbRequest	withMountOptions(SmbMountOptions mountOptions) The mount options used by DataSync to access the SMB server.
CreateLocationSmbRequest	withPassword(String password) The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
CreateLocationSmbRequest	withServerHostname(String serverHostname) The name of the SMB server.
CreateLocationSmbRequest	withSubdirectory(String subdirectory) The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.
CreateLocationSmbRequest	withTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the location.
CreateLocationSmbRequest	withTags(TagListEntry... tags) The key-value pair that represents the tag that you want to add to the location.
CreateLocationSmbRequest	withUser(String user) The user who can mount the share, has the permissions to access files and folders in the SMB share.

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)

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Parameters:

subdirectory - The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

getSubdirectory

public String getSubdirectory()

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Returns:

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

withSubdirectory

public CreateLocationSmbRequest withSubdirectory(String subdirectory)

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Parameters:

subdirectory - The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Returns:

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

setServerHostname

public void setServerHostname(String serverHostname)

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Parameters:

serverHostname - The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

getServerHostname

public String getServerHostname()

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Returns:

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

withServerHostname

public CreateLocationSmbRequest withServerHostname(String serverHostname)

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Parameters:

serverHostname - The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Returns:

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

setUser

public void setUser(String user)

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Parameters:

user - The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

getUser

public String getUser()

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Returns:

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

withUser

public CreateLocationSmbRequest withUser(String user)

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Parameters:

user - The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Returns:

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

setDomain

public void setDomain(String domain)

The name of the Windows domain that the SMB server belongs to.

Parameters:

domain - The name of the Windows domain that the SMB server belongs to.

getDomain

public String getDomain()

The name of the Windows domain that the SMB server belongs to.

Returns:

The name of the Windows domain that the SMB server belongs to.

withDomain

public CreateLocationSmbRequest withDomain(String domain)

The name of the Windows domain that the SMB server belongs to.

Parameters:

domain - The name of the Windows domain that the SMB server belongs to.

Returns:

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

setPassword

public void setPassword(String password)

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Parameters:

password - The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

getPassword

public String getPassword()

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Returns:

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

withPassword

public CreateLocationSmbRequest withPassword(String password)

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Parameters:

password - The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Returns:

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

getAgentArns

public List<String> getAgentArns()

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

setAgentArns

public void setAgentArns(Collection<String> agentArns)

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Parameters:

agentArns - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

withAgentArns

public CreateLocationSmbRequest withAgentArns(String... agentArns)

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

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 - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

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

withAgentArns

public CreateLocationSmbRequest withAgentArns(Collection<String> agentArns)

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Parameters:

agentArns - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

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

setMountOptions

public void setMountOptions(SmbMountOptions mountOptions)

The mount options used by DataSync to access the SMB server.

Parameters:

mountOptions - The mount options used by DataSync to access the SMB server.

getMountOptions

public SmbMountOptions getMountOptions()

The mount options used by DataSync to access the SMB server.

Returns:

The mount options used by DataSync to access the SMB server.

withMountOptions

public CreateLocationSmbRequest withMountOptions(SmbMountOptions mountOptions)

The mount options used by DataSync to access the SMB server.

Parameters:

mountOptions - The mount options used by DataSync to access the SMB server.

Returns:

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

getTags

public List<TagListEntry> getTags()

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.

Returns:

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.

setTags

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

Parameters:

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.

withTags

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

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

Returns:

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

withTags

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

Parameters:

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.

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