java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.datasync.model.DataSyncResponse
    - - software.amazon.awssdk.services.datasync.model.DescribeLocationSmbResponse

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

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

DescribeLocationSmbResponse

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeLocationSmbResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`agentArns()`	The ARNs of the DataSync agents that can connect with your SMB file server.
`SmbAuthenticationType`	`authenticationType()`	The authentication protocol that DataSync uses to connect to your SMB file server.
`String`	`authenticationTypeAsString()`	The authentication protocol that DataSync uses to connect to your SMB file server.
`static DescribeLocationSmbResponse.Builder`	`builder()`
`Instant`	`creationTime()`	The time that the SMB location was created.
`List<String>`	`dnsIpAddresses()`	The IPv4 addresses for the DNS servers that your SMB file server belongs to.
`String`	`domain()`	The name of the Windows domain that the 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.
`boolean`	`hasDnsIpAddresses()`	For responses, this returns true if the service returned a value for the DnsIpAddresses property.
`int`	`hashCode()`
`String`	`kerberosPrincipal()`	The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.
`String`	`locationArn()`	The ARN of the SMB location.
`String`	`locationUri()`	The URI of the SMB location.
`SmbMountOptions`	`mountOptions()`	The SMB protocol version that DataSync uses to access your SMB file server.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeLocationSmbResponse.Builder>`	`serializableBuilderClass()`
`DescribeLocationSmbResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`user()`	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.services.datasync.model.DataSyncResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 ARN of the SMB location.
    
    Returns:
    
    The ARN of the SMB location.
  - locationUri
```
public final String locationUri()
```
    The URI of the SMB location.
    
    Returns:
    
    The URI of the SMB location.
  - 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 ARNs of the DataSync agents that can connect with your SMB file server.
    
    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 ARNs of the DataSync agents that can connect with your SMB file server.
  - user
```
public final String user()
```
    The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if AuthenticationType is set to NTLM.
    
    Returns:
    
    The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if AuthenticationType is set to NTLM.
  - domain
```
public final String domain()
```
    The name of the Windows domain that the SMB file server belongs to. This element applies only if AuthenticationType is set to NTLM.
    
    Returns:
    
    The name of the Windows domain that the SMB file server belongs to. This element applies only if AuthenticationType is set to NTLM.
  - mountOptions
```
public final SmbMountOptions mountOptions()
```
    The SMB protocol version that DataSync uses to access your SMB file server.
    
    Returns:
    
    The SMB protocol version that DataSync uses to access your SMB file server.
  - creationTime
```
public final Instant creationTime()
```
    The time that the SMB location was created.
    
    Returns:
    
    The time that the SMB location was created.
  - hasDnsIpAddresses
```
public final boolean hasDnsIpAddresses()
```
    For responses, this returns true if the service returned a value for the DnsIpAddresses 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.
  - dnsIpAddresses
```
public final List<String> dnsIpAddresses()
```
    The IPv4 addresses for the DNS servers that your SMB file server belongs to. This element applies only if AuthenticationType is set to KERBEROS.
    
    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 hasDnsIpAddresses() method.
    
    Returns:
    
    The IPv4 addresses for the DNS servers that your SMB file server belongs to. This element applies only if AuthenticationType is set to KERBEROS.
  - kerberosPrincipal
```
public final String kerberosPrincipal()
```
    The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.
    
    Returns:
    
    The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.
  - authenticationType
```
public final SmbAuthenticationType authenticationType()
```
    The authentication protocol that DataSync uses to connect to your SMB file server.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return SmbAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The authentication protocol that DataSync uses to connect to your SMB file server.
    
    See Also:
    
    SmbAuthenticationType
  - authenticationTypeAsString
```
public final String authenticationTypeAsString()
```
    The authentication protocol that DataSync uses to connect to your SMB file server.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return SmbAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The authentication protocol that DataSync uses to connect to your SMB file server.
    
    See Also:
    
    SmbAuthenticationType
  - toBuilder
```
public DescribeLocationSmbResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeLocationSmbResponse.Builder,DescribeLocationSmbResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeLocationSmbResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeLocationSmbResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeLocationSmbResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.datasync.model.DataSyncResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

locationArn

locationUri

hasAgentArns

agentArns

user

domain

mountOptions

creationTime

hasDnsIpAddresses

dnsIpAddresses

kerberosPrincipal

authenticationType

authenticationTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField