software.amazon.awssdk.services.datasync.model

Class UpdateLocationSmbRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.UpdateLocationSmbRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateLocationSmbRequest.Builder,UpdateLocationSmbRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateLocationSmbRequest
extends DataSyncRequest
implements ToCopyableBuilder<UpdateLocationSmbRequest.Builder,UpdateLocationSmbRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateLocationSmbRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agentArns() The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
static UpdateLocationSmbRequest.Builder	builder()
String	domain() The name of the Windows domain that the SMB server belongs to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentArns() For responses, this returns true if the service returned a value for the AgentArns property.
int	hashCode()
String	locationArn() The Amazon Resource Name (ARN) of the SMB location to update.
SmbMountOptions	mountOptions() Returns the value of the MountOptions property for this object.
String	password() The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateLocationSmbRequest.Builder>	serializableBuilderClass()
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.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

locationArn

public final String locationArn()

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

Returns:

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

subdirectory

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

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.

user

public final String user()

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.

domain

public final String domain()

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.

password

public final String password()

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.

hasAgentArns

public final boolean hasAgentArns()

For responses, this returns true if the service returned a value for the AgentArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

agentArns

public final List<String> agentArns()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAgentArns() method.

Returns:

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

mountOptions

public final SmbMountOptions mountOptions()

Returns the value of the MountOptions property for this object.

Returns:

The value of the MountOptions property for this object.

toBuilder

public UpdateLocationSmbRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateLocationSmbRequest.Builder,UpdateLocationSmbRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static UpdateLocationSmbRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateLocationSmbRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo