Class 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

  • Method Details

    • 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

      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.