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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>

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

CreateLocationSmbRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateLocationSmbRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`agentArns()`	Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.
`static CreateLocationSmbRequest.Builder`	`builder()`
`String`	`domain()`	Specifies the name of the Active Directory domain that your SMB file 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()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`SmbMountOptions`	`mountOptions()`	Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateLocationSmbRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverHostname()`	Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
`String`	`subdirectory()`	Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
`List<TagListEntry>`	`tags()`	Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
`CreateLocationSmbRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`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 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
  - subdirectory
```
public final 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.
    
    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.
  - serverHostname
```
public final 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.
    
    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.
  - user
```
public final 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.
    
    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.
  - domain
```
public final 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.
    
    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.
  - password
```
public final 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.
    
    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.
  - 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()
```
    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).
    
    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:
    
    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).
  - mountOptions
```
public final SmbMountOptions mountOptions()
```
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<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.
    
    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 hasTags() method.
    
    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.
  - toBuilder
```
public CreateLocationSmbRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>
    
    Specified by:
    
    toBuilder in class DataSyncRequest
  - builder
```
public static CreateLocationSmbRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLocationSmbRequest.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

Class CreateLocationSmbRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

subdirectory

serverHostname

user

domain

password

hasAgentArns

agentArns

mountOptions

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields