Class TaskOptions


  • public final class TaskOptions
    extends java.lang.Object
    • Method Detail

      • atime

        public java.util.Optional<java.lang.String> atime()
        Returns:
        A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to `BEST_EFFORT`, the DataSync Task attempts to preserve the original (that is, the version before sync `PREPARING` phase) `atime` attribute on all source files. Valid values: `BEST_EFFORT`, `NONE`. Default: `BEST_EFFORT`.
      • bytesPerSecond

        public java.util.Optional<java.lang.Integer> bytesPerSecond()
        Returns:
        Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to `1048576`. Value values: `-1` or greater. Default: `-1` (unlimited).
      • gid

        public java.util.Optional<java.lang.String> gid()
        Returns:
        Group identifier of the file's owners. Valid values: `BOTH`, `INT_VALUE`, `NAME`, `NONE`. Default: `INT_VALUE` (preserve integer value of the ID).
      • logLevel

        public java.util.Optional<java.lang.String> logLevel()
        Returns:
        Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: `OFF`, `BASIC`, `TRANSFER`. Default: `OFF`.
      • mtime

        public java.util.Optional<java.lang.String> mtime()
        Returns:
        A file metadata that indicates the last time a file was modified (written to) before the sync `PREPARING` phase. Value values: `NONE`, `PRESERVE`. Default: `PRESERVE`.
      • objectTags

        public java.util.Optional<java.lang.String> objectTags()
        Returns:
        Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: `PRESERVE`, `NONE`. Default value: `PRESERVE`.
      • overwriteMode

        public java.util.Optional<java.lang.String> overwriteMode()
        Returns:
        Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: `ALWAYS`, `NEVER`. Default: `ALWAYS`.
      • posixPermissions

        public java.util.Optional<java.lang.String> posixPermissions()
        Returns:
        Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: `NONE`, `PRESERVE`. Default: `PRESERVE`.
      • preserveDeletedFiles

        public java.util.Optional<java.lang.String> preserveDeletedFiles()
        Returns:
        Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: `PRESERVE`, `REMOVE`. Default: `PRESERVE`.
      • preserveDevices

        public java.util.Optional<java.lang.String> preserveDevices()
        Returns:
        Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: `NONE`, `PRESERVE`. Default: `NONE` (ignore special devices).
      • securityDescriptorCopyFlags

        public java.util.Optional<java.lang.String> securityDescriptorCopyFlags()
        Returns:
        Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: `NONE`, `OWNER_DACL`, `OWNER_DACL_SACL`. Default: `OWNER_DACL`.
      • taskQueueing

        public java.util.Optional<java.lang.String> taskQueueing()
        Returns:
        Determines whether tasks should be queued before executing the tasks. Valid values: `ENABLED`, `DISABLED`. Default `ENABLED`.
      • transferMode

        public java.util.Optional<java.lang.String> transferMode()
        Returns:
        Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: `CHANGED`, `ALL`. Default: `CHANGED`
      • uid

        public java.util.Optional<java.lang.String> uid()
        Returns:
        User identifier of the file's owners. Valid values: `BOTH`, `INT_VALUE`, `NAME`, `NONE`. Default: `INT_VALUE` (preserve integer value of the ID).
      • verifyMode

        public java.util.Optional<java.lang.String> verifyMode()
        Returns:
        Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: `NONE`, `POINT_IN_TIME_CONSISTENT`, `ONLY_FILES_TRANSFERRED`. Default: `POINT_IN_TIME_CONSISTENT`.