com.amazonaws.services.datasync.model

Class UpdateLocationSmbRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.UpdateLocationSmbRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateLocationSmbRequest()

Method Summary

Modifier and Type	Method and Description
UpdateLocationSmbRequest	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.
String	getLocationArn() The Amazon Resource Name (ARN) of the SMB location to update.
SmbMountOptions	getMountOptions()
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	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.
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	setLocationArn(String locationArn) The Amazon Resource Name (ARN) of the SMB location to update.
void	setMountOptions(SmbMountOptions mountOptions)
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	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	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.
UpdateLocationSmbRequest	withAgentArns(Collection<String> agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
UpdateLocationSmbRequest	withAgentArns(String... agentArns) The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
UpdateLocationSmbRequest	withDomain(String domain) The name of the Windows domain that the SMB server belongs to.
UpdateLocationSmbRequest	withLocationArn(String locationArn) The Amazon Resource Name (ARN) of the SMB location to update.
UpdateLocationSmbRequest	withMountOptions(SmbMountOptions mountOptions)
UpdateLocationSmbRequest	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.
UpdateLocationSmbRequest	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.
UpdateLocationSmbRequest	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

UpdateLocationSmbRequest

public UpdateLocationSmbRequest()

Method Detail

setLocationArn

public void setLocationArn(String locationArn)

The Amazon Resource Name (ARN) of the SMB location to update.

Parameters:

locationArn - The Amazon Resource Name (ARN) of the SMB location to update.

getLocationArn

public String getLocationArn()

The Amazon Resource Name (ARN) of the SMB location to update.

Returns:

The Amazon Resource Name (ARN) of the SMB location to update.

withLocationArn

public UpdateLocationSmbRequest withLocationArn(String locationArn)

The Amazon Resource Name (ARN) of the SMB location to update.

Parameters:

locationArn - The Amazon Resource Name (ARN) of the SMB location to update.

Returns:

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

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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

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

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also 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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

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

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also 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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

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

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also 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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

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

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

withSubdirectory

public UpdateLocationSmbRequest 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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

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

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also 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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

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

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

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.

Parameters:

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

getUser

public String getUser()

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

Returns:

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

withUser

public UpdateLocationSmbRequest withUser(String user)

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

Parameters:

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

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

Parameters:

mountOptions -

getMountOptions

public SmbMountOptions getMountOptions()

Returns:

withMountOptions

public UpdateLocationSmbRequest withMountOptions(SmbMountOptions mountOptions)

Parameters:

mountOptions -

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