Package software.amazon.awssdk.services.datasync.model

Class SmbMountOptions

java.lang.Object

software.amazon.awssdk.services.datasync.model.SmbMountOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SmbMountOptions.Builder,SmbMountOptions>

@Generated("software.amazon.awssdk:codegen")
public final class SmbMountOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SmbMountOptions.Builder,SmbMountOptions>

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SmbMountOptions.Builder

Method Summary

Modifier and Type	Method	Description
static SmbMountOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SmbMountOptions.Builder>	serializableBuilderClass()
SmbMountOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SmbVersion	version()	By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server.
String	versionAsString()	By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server.

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

version

public final SmbVersion version()

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

• AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

  This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

• SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

• SMB2: Restricts the protocol negotiation to only SMB version 2.1.

• SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

• SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.

If the service returns an enum value that is not available in the current SDK version, version will return SmbVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionAsString().

Returns:

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

• AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

  This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

• SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

• SMB2: Restricts the protocol negotiation to only SMB version 2.1.

• SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

• SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.

See Also:

SmbVersion

versionAsString

public final String versionAsString()

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

• AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

  This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

• SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

• SMB2: Restricts the protocol negotiation to only SMB version 2.1.

• SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

• SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.

If the service returns an enum value that is not available in the current SDK version, version will return SmbVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionAsString().

Returns:

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

• AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

  This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

• SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

• SMB2: Restricts the protocol negotiation to only SMB version 2.1.

• SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

• SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.

See Also:

SmbVersion

toBuilder

public SmbMountOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SmbMountOptions.Builder,SmbMountOptions>

builder

public static SmbMountOptions.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo