Options (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.datasync.model.Options

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Options
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Options()

Constructors
Constructor and Description
`Options()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Options`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAtime()` A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
`Long`	`getBytesPerSecond()` A value that limits the bandwidth used by DataSync.
`String`	`getGid()` The POSIX group ID (GID) of the file's owners.
`String`	`getLogLevel()` A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
`String`	`getMtime()` A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
`String`	`getOverwriteMode()` A value that determines whether files at the destination should be overwritten or preserved when copying files.
`String`	`getPosixPermissions()` A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
`String`	`getPreserveDeletedFiles()` A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
`String`	`getPreserveDevices()` A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination.
`String`	`getSecurityDescriptorCopyFlags()` A value that determines which components of the SMB security descriptor are copied from source to destination objects.
`String`	`getTaskQueueing()` A value that determines whether tasks should be queued before executing the tasks.
`String`	`getTransferMode()` A value that 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.
`String`	`getUid()` The POSIX user ID (UID) of the file's owner.
`String`	`getVerifyMode()` A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAtime(String atime)` A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
`void`	`setBytesPerSecond(Long bytesPerSecond)` A value that limits the bandwidth used by DataSync.
`void`	`setGid(String gid)` The POSIX group ID (GID) of the file's owners.
`void`	`setLogLevel(String logLevel)` A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
`void`	`setMtime(String mtime)` A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
`void`	`setOverwriteMode(String overwriteMode)` A value that determines whether files at the destination should be overwritten or preserved when copying files.
`void`	`setPosixPermissions(String posixPermissions)` A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
`void`	`setPreserveDeletedFiles(String preserveDeletedFiles)` A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
`void`	`setPreserveDevices(String preserveDevices)` A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination.
`void`	`setSecurityDescriptorCopyFlags(String securityDescriptorCopyFlags)` A value that determines which components of the SMB security descriptor are copied from source to destination objects.
`void`	`setTaskQueueing(String taskQueueing)` A value that determines whether tasks should be queued before executing the tasks.
`void`	`setTransferMode(String transferMode)` A value that 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.
`void`	`setUid(String uid)` The POSIX user ID (UID) of the file's owner.
`void`	`setVerifyMode(String verifyMode)` A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
`String`	`toString()` Returns a string representation of this object.
`Options`	`withAtime(Atime atime)` A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
`Options`	`withAtime(String atime)` A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
`Options`	`withBytesPerSecond(Long bytesPerSecond)` A value that limits the bandwidth used by DataSync.
`Options`	`withGid(Gid gid)` The POSIX group ID (GID) of the file's owners.
`Options`	`withGid(String gid)` The POSIX group ID (GID) of the file's owners.
`Options`	`withLogLevel(LogLevel logLevel)` A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
`Options`	`withLogLevel(String logLevel)` A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
`Options`	`withMtime(Mtime mtime)` A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
`Options`	`withMtime(String mtime)` A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
`Options`	`withOverwriteMode(OverwriteMode overwriteMode)` A value that determines whether files at the destination should be overwritten or preserved when copying files.
`Options`	`withOverwriteMode(String overwriteMode)` A value that determines whether files at the destination should be overwritten or preserved when copying files.
`Options`	`withPosixPermissions(PosixPermissions posixPermissions)` A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
`Options`	`withPosixPermissions(String posixPermissions)` A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
`Options`	`withPreserveDeletedFiles(PreserveDeletedFiles preserveDeletedFiles)` A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
`Options`	`withPreserveDeletedFiles(String preserveDeletedFiles)` A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
`Options`	`withPreserveDevices(PreserveDevices preserveDevices)` A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination.
`Options`	`withPreserveDevices(String preserveDevices)` A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination.
`Options`	`withSecurityDescriptorCopyFlags(SmbSecurityDescriptorCopyFlags securityDescriptorCopyFlags)` A value that determines which components of the SMB security descriptor are copied from source to destination objects.
`Options`	`withSecurityDescriptorCopyFlags(String securityDescriptorCopyFlags)` A value that determines which components of the SMB security descriptor are copied from source to destination objects.
`Options`	`withTaskQueueing(String taskQueueing)` A value that determines whether tasks should be queued before executing the tasks.
`Options`	`withTaskQueueing(TaskQueueing taskQueueing)` A value that determines whether tasks should be queued before executing the tasks.
`Options`	`withTransferMode(String transferMode)` A value that 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.
`Options`	`withTransferMode(TransferMode transferMode)` A value that 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.
`Options`	`withUid(String uid)` The POSIX user ID (UID) of the file's owner.
`Options`	`withUid(Uid uid)` The POSIX user ID (UID) of the file's owner.
`Options`	`withVerifyMode(String verifyMode)` A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
`Options`	`withVerifyMode(VerifyMode verifyMode)` A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Options
```
public Options()
```
- Method Detail
  - setVerifyMode
```
public void setVerifyMode(String verifyMode)
```
    A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    Parameters:
    
    verifyMode - A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    See Also:
    
    VerifyMode
  - getVerifyMode
```
public String getVerifyMode()
```
    A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    Returns:
    
    A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    See Also:
    
    VerifyMode
  - withVerifyMode
```
public Options withVerifyMode(String verifyMode)
```
    A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    Parameters:
    
    verifyMode - A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifyMode
  - withVerifyMode
```
public Options withVerifyMode(VerifyMode verifyMode)
```
    A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    Parameters:
    
    verifyMode - A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.
    
    Default value: POINT_IN_TIME_CONSISTENT.
    
    ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
    
    POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
    
    NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifyMode
  - setOverwriteMode
```
public void setOverwriteMode(String overwriteMode)
```
    A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Parameters:
    
    overwriteMode - A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    See Also:
    
    OverwriteMode
  - getOverwriteMode
```
public String getOverwriteMode()
```
    A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Returns:
    
    A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    See Also:
    
    OverwriteMode
  - withOverwriteMode
```
public Options withOverwriteMode(String overwriteMode)
```
    A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Parameters:
    
    overwriteMode - A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OverwriteMode
  - withOverwriteMode
```
public Options withOverwriteMode(OverwriteMode overwriteMode)
```
    A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Parameters:
    
    overwriteMode - A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.
    
    Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OverwriteMode
  - setAtime
```
public void setAtime(String atime)
```
    A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    Parameters:
    
    atime - A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    See Also:
    
    Atime
  - getAtime
```
public String getAtime()
```
    A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    Returns:
    
    A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    See Also:
    
    Atime
  - withAtime
```
public Options withAtime(String atime)
```
    A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    Parameters:
    
    atime - A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Atime
  - withAtime
```
public Options withAtime(Atime atime)
```
    A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    Parameters:
    
    atime - A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.
    
    Default value: BEST_EFFORT.
    
    BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
    
    NONE: Ignore Atime.
    
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
    
    If Atime is set to NONE, Mtime must also be NONE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Atime
  - setMtime
```
public void setMtime(String mtime)
```
    A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    Parameters:
    
    mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    See Also:
    
    Mtime
  - getMtime
```
public String getMtime()
```
    A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    Returns:
    
    A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    See Also:
    
    Mtime
  - withMtime
```
public Options withMtime(String mtime)
```
    A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    Parameters:
    
    mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Mtime
  - withMtime
```
public Options withMtime(Mtime mtime)
```
    A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    Parameters:
    
    mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve original Mtime (recommended)
    
    NONE: Ignore Mtime.
    
    If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
    
    If Mtime is set to NONE, Atime must also be set to NONE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Mtime
  - setUid
```
public void setUid(String uid)
```
    The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    Parameters:
    
    uid - The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    See Also:
    
    Uid
  - getUid
```
public String getUid()
```
    The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    Returns:
    
    The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    See Also:
    
    Uid
  - withUid
```
public Options withUid(String uid)
```
    The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    Parameters:
    
    uid - The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Uid
  - withUid
```
public Options withUid(Uid uid)
```
    The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    Parameters:
    
    uid - The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
    
    NONE: Ignore UID and GID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Uid
  - setGid
```
public void setGid(String gid)
```
    The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    Parameters:
    
    gid - The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    See Also:
    
    Gid
  - getGid
```
public String getGid()
```
    The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    Returns:
    
    The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    See Also:
    
    Gid
  - withGid
```
public Options withGid(String gid)
```
    The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    Parameters:
    
    gid - The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Gid
  - withGid
```
public Options withGid(Gid gid)
```
    The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    Parameters:
    
    gid - The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: INT_VALUE. This preserves the integer value of the ID.
    
    INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
    
    NONE: Ignore UID and GID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Gid
  - setPreserveDeletedFiles
```
public void setPreserveDeletedFiles(String preserveDeletedFiles)
```
    A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    Parameters:
    
    preserveDeletedFiles - A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    See Also:
    
    PreserveDeletedFiles
  - getPreserveDeletedFiles
```
public String getPreserveDeletedFiles()
```
    A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    Returns:
    
    A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    See Also:
    
    PreserveDeletedFiles
  - withPreserveDeletedFiles
```
public Options withPreserveDeletedFiles(String preserveDeletedFiles)
```
    A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    Parameters:
    
    preserveDeletedFiles - A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreserveDeletedFiles
  - withPreserveDeletedFiles
```
public Options withPreserveDeletedFiles(PreserveDeletedFiles preserveDeletedFiles)
```
    A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    Parameters:
    
    preserveDeletedFiles - A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
    
    Default value: PRESERVE.
    
    PRESERVE: Ignore such destination files (recommended).
    
    REMOVE: Delete destination files that aren’t present in the source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreserveDeletedFiles
  - setPreserveDevices
```
public void setPreserveDevices(String preserveDevices)
```
    A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    Parameters:
    
    preserveDevices - A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    See Also:
    
    PreserveDevices
  - getPreserveDevices
```
public String getPreserveDevices()
```
    A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    Returns:
    
    A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    See Also:
    
    PreserveDevices
  - withPreserveDevices
```
public Options withPreserveDevices(String preserveDevices)
```
    A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    Parameters:
    
    preserveDevices - A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreserveDevices
  - withPreserveDevices
```
public Options withPreserveDevices(PreserveDevices preserveDevices)
```
    A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    Parameters:
    
    preserveDevices - A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
    
    DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.
    
    Default value: NONE.
    
    NONE: Ignore special devices (recommended).
    
    PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreserveDevices
  - setPosixPermissions
```
public void setPosixPermissions(String posixPermissions)
```
    A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    Parameters:
    
    posixPermissions - A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    See Also:
    
    PosixPermissions
  - getPosixPermissions
```
public String getPosixPermissions()
```
    A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    Returns:
    
    A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    See Also:
    
    PosixPermissions
  - withPosixPermissions
```
public Options withPosixPermissions(String posixPermissions)
```
    A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    Parameters:
    
    posixPermissions - A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PosixPermissions
  - withPosixPermissions
```
public Options withPosixPermissions(PosixPermissions posixPermissions)
```
    A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    Parameters:
    
    posixPermissions - A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
    
    Default value: PRESERVE.
    
    PRESERVE: Preserve POSIX-style permissions (recommended).
    
    NONE: Ignore permissions.
    
    DataSync can preserve extant permissions of a source location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PosixPermissions
  - setBytesPerSecond
```
public void setBytesPerSecond(Long bytesPerSecond)
```
    A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
    
    Parameters:
    
    bytesPerSecond - A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
  - getBytesPerSecond
```
public Long getBytesPerSecond()
```
    A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
    
    Returns:
    
    A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
  - withBytesPerSecond
```
public Options withBytesPerSecond(Long bytesPerSecond)
```
    A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
    
    Parameters:
    
    bytesPerSecond - A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskQueueing
```
public void setTaskQueueing(String taskQueueing)
```
    A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED , the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    Parameters:
    
    taskQueueing - A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    See Also:
    
    TaskQueueing
  - getTaskQueueing
```
public String getTaskQueueing()
```
    A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED , the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    Returns:
    
    A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    See Also:
    
    TaskQueueing
  - withTaskQueueing
```
public Options withTaskQueueing(String taskQueueing)
```
    A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED , the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    Parameters:
    
    taskQueueing - A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskQueueing
  - withTaskQueueing
```
public Options withTaskQueueing(TaskQueueing taskQueueing)
```
    A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED , the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    Parameters:
    
    taskQueueing - A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
    
    If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskQueueing
  - setLogLevel
```
public void setLogLevel(String logLevel)
```
    A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    Parameters:
    
    logLevel - A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    See Also:
    
    LogLevel
  - getLogLevel
```
public String getLogLevel()
```
    A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    Returns:
    
    A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    See Also:
    
    LogLevel
  - withLogLevel
```
public Options withLogLevel(String logLevel)
```
    A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    Parameters:
    
    logLevel - A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogLevel
  - withLogLevel
```
public Options withLogLevel(LogLevel logLevel)
```
    A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    Parameters:
    
    logLevel - A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogLevel
  - setTransferMode
```
public void setTransferMode(String transferMode)
```
    A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    Parameters:
    
    transferMode - A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    See Also:
    
    TransferMode
  - getTransferMode
```
public String getTransferMode()
```
    A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    Returns:
    
    A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    See Also:
    
    TransferMode
  - withTransferMode
```
public Options withTransferMode(String transferMode)
```
    A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    Parameters:
    
    transferMode - A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransferMode
  - withTransferMode
```
public Options withTransferMode(TransferMode transferMode)
```
    A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    Parameters:
    
    transferMode - A value that 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.
    
    CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.
    
    ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransferMode
  - setSecurityDescriptorCopyFlags
```
public void setSecurityDescriptorCopyFlags(String securityDescriptorCopyFlags)
```
    A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    - NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    Parameters:
    securityDescriptorCopyFlags - A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    See Also:
    
    SmbSecurityDescriptorCopyFlags
  - getSecurityDescriptorCopyFlags
```
public String getSecurityDescriptorCopyFlags()
```
    A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    - NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    Returns:
    A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    See Also:
    
    SmbSecurityDescriptorCopyFlags
  - withSecurityDescriptorCopyFlags
```
public Options withSecurityDescriptorCopyFlags(String securityDescriptorCopyFlags)
```
    A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    - NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    Parameters:
    securityDescriptorCopyFlags - A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SmbSecurityDescriptorCopyFlags
  - withSecurityDescriptorCopyFlags
```
public Options withSecurityDescriptorCopyFlags(SmbSecurityDescriptorCopyFlags securityDescriptorCopyFlags)
```
    A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    - Object owner.
    - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    - NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    Parameters:
    securityDescriptorCopyFlags - A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
    
    Default value: OWNER_DACL.
    
    OWNER_DACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
    
    Object owner.
    
    NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    
    NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
    
    Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
    
    NONE: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SmbSecurityDescriptorCopyFlags
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Options clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Options

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Options

Method Detail

setVerifyMode

getVerifyMode

withVerifyMode

withVerifyMode

setOverwriteMode

getOverwriteMode

withOverwriteMode

withOverwriteMode

setAtime

getAtime

withAtime

withAtime

setMtime

getMtime

withMtime

withMtime

setUid

getUid

withUid

withUid

setGid

getGid

withGid

withGid

setPreserveDeletedFiles

getPreserveDeletedFiles

withPreserveDeletedFiles

withPreserveDeletedFiles

setPreserveDevices

getPreserveDevices

withPreserveDevices

withPreserveDevices

setPosixPermissions

getPosixPermissions

withPosixPermissions

withPosixPermissions

setBytesPerSecond

getBytesPerSecond

withBytesPerSecond

setTaskQueueing

getTaskQueueing

withTaskQueueing

withTaskQueueing

setLogLevel

getLogLevel

withLogLevel

withLogLevel

setTransferMode

getTransferMode

withTransferMode

withTransferMode

setSecurityDescriptorCopyFlags

getSecurityDescriptorCopyFlags

withSecurityDescriptorCopyFlags

withSecurityDescriptorCopyFlags

toString

equals

hashCode

clone

marshall