Class DescribeLocationSmbResponse

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

  • Method Details

    • 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 or IPv6 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 or IPv6 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:

    • 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:

    • toBuilder

      public DescribeLocationSmbResponse.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<DescribeLocationSmbResponse.Builder,DescribeLocationSmbResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.