CreateLocationSmbRequest (AWS SDK for Java

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(value="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 and Description

static interface CreateLocationSmbRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateLocationSmbRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 CreateLocationSmbRequest.Builder`	`builder()`
`String`	`domain()` The name of the Windows domain that the SMB server belongs to.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasAgentArns()` Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`SmbMountOptions`	`mountOptions()` The mount options used by DataSync to access the SMB server.
`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 CreateLocationSmbRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverHostname()` The name of the SMB server.
`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.
`List<TagListEntry>`	`tags()` The key-value pair that represents the tag that you want to add to the location.
`CreateLocationSmbRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - 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 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.
  - serverHostname
```
public final 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.
    
    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.
  - 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()
```
    Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasAgentArns() to see if a value was sent in this field.
    
    Returns:
    
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
  - mountOptions
```
public final SmbMountOptions mountOptions()
```
    The mount options used by DataSync to access the SMB server.
    
    Returns:
    
    The mount options used by DataSync to access the SMB server.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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.
  - toBuilder
```
public CreateLocationSmbRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>
    
    Specified by:
    
    toBuilder in class DataSyncRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.62

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