@Generated(value="software.amazon.awssdk:codegen") public final class CreateLocationSmbRequest extends DataSyncRequest implements ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>
CreateLocationSmbRequest
Modifier and Type | Class and Description |
---|---|
static interface |
CreateLocationSmbRequest.Builder |
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.
|
overrideConfiguration
copy
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.
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.
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.
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
public final String user()
The user who can mount the share, has the permissions to access files and folders in the SMB share.
public final String domain()
The name of the Windows domain that the SMB server belongs to.
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.
public final boolean hasAgentArns()
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.
public final SmbMountOptions mountOptions()
The mount options used by DataSync to access the SMB server.
public final boolean hasTags()
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.
public CreateLocationSmbRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateLocationSmbRequest.Builder,CreateLocationSmbRequest>
toBuilder
in class DataSyncRequest
public static CreateLocationSmbRequest.Builder builder()
public static Class<? extends CreateLocationSmbRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.