@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.
| Constructor and Description |
|---|
Options() |
| 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 AWS DataSync.
|
String |
getGid()
The 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 AWS DataSync should preserve the metadata of block and character devices in the
source file system, and recreate the files with that device name and metadata on the destination.
|
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 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 AWS DataSync.
|
void |
setGid(String gid)
The 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 AWS DataSync should preserve the metadata of block and character devices in the
source file system, and recreate the files with that device name and metadata on the destination.
|
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 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 AWS DataSync.
|
Options |
withGid(Gid gid)
The group ID (GID) of the file's owners.
|
Options |
withGid(String gid)
The 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 AWS DataSync should preserve the metadata of block and character devices in the
source file system, and recreate the files with that device name and metadata on the destination.
|
Options |
withPreserveDevices(String preserveDevices)
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the
source file system, and recreate the files with that device name and metadata on the destination.
|
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 user ID (UID) of the file's owner.
|
Options |
withUid(Uid uid)
The 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.
|
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 create-task
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.
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 create-task
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.
VerifyModepublic 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 create-task
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.
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.
VerifyModepublic 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 create-task
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.
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 create-task
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.
VerifyModepublic 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 create-task
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.
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 create-task
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.
VerifyModepublic 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 using-storage-classes in the AWS DataSync User Guide.
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 using-storage-classes in the AWS DataSync User Guide.
OverwriteModepublic 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 using-storage-classes in the AWS DataSync User Guide.
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 using-storage-classes in the AWS DataSync User Guide.
OverwriteModepublic 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 using-storage-classes in the AWS DataSync User Guide.
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 using-storage-classes in the AWS DataSync User Guide.
OverwriteModepublic 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 using-storage-classes in the AWS DataSync User Guide.
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 using-storage-classes in the AWS DataSync User Guide.
OverwriteModepublic 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 AWS 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.
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 AWS 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.
Atimepublic 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 AWS 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.
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 AWS 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.
Atimepublic 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 AWS 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.
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 AWS 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.
Atimepublic 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 AWS 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.
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 AWS 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.
Atimepublic 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.
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.
mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the
PREPARING phase.
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.
Mtimepublic 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.
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.
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.
Mtimepublic 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.
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.
mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the
PREPARING phase.
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.
Mtimepublic 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.
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.
mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the
PREPARING phase.
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.
Mtimepublic void setUid(String uid)
The user ID (UID) of the file's owner.
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.
uid - The user ID (UID) of the file's owner.
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.
Uidpublic String getUid()
The user ID (UID) of the file's owner.
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.
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.
Uidpublic Options withUid(String uid)
The user ID (UID) of the file's owner.
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.
uid - The user ID (UID) of the file's owner.
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.
Uidpublic Options withUid(Uid uid)
The user ID (UID) of the file's owner.
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.
uid - The user ID (UID) of the file's owner.
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.
Uidpublic void setGid(String gid)
The group ID (GID) of the file's owners.
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.
gid - The group ID (GID) of the file's owners.
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.
Gidpublic String getGid()
The group ID (GID) of the file's owners.
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.
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.
Gidpublic Options withGid(String gid)
The group ID (GID) of the file's owners.
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.
gid - The group ID (GID) of the file's owners.
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.
Gidpublic Options withGid(Gid gid)
The group ID (GID) of the file's owners.
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.
gid - The group ID (GID) of the file's owners.
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.
Gidpublic 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 using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
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
using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDeletedFilespublic 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 using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDeletedFilespublic 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 using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
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
using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDeletedFilespublic 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 using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
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
using-storage-classes in the AWS DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDeletedFilespublic void setPreserveDevices(String preserveDevices)
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
AWS 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.
preserveDevices - A value that determines whether AWS DataSync should preserve the metadata of block and character devices
in the source file system, and recreate the files with that device name and metadata on the
destination. AWS 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.
PreserveDevicespublic String getPreserveDevices()
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
AWS 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.
AWS 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.
PreserveDevicespublic Options withPreserveDevices(String preserveDevices)
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
AWS 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.
preserveDevices - A value that determines whether AWS DataSync should preserve the metadata of block and character devices
in the source file system, and recreate the files with that device name and metadata on the
destination. AWS 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.
PreserveDevicespublic Options withPreserveDevices(PreserveDevices preserveDevices)
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
AWS 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.
preserveDevices - A value that determines whether AWS DataSync should preserve the metadata of block and character devices
in the source file system, and recreate the files with that device name and metadata on the
destination. AWS 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.
PreserveDevicespublic 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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
PosixPermissionspublic 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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
PosixPermissionspublic 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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
PosixPermissionspublic 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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
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.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
PosixPermissionspublic void setBytesPerSecond(Long bytesPerSecond)
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of
1 MB, set this value to 1048576 (=1024*1024).
bytesPerSecond - A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a
maximum of 1 MB, set this value to 1048576 (=1024*1024).public Long getBytesPerSecond()
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of
1 MB, set this value to 1048576 (=1024*1024).
1048576 (=1024*1024).public Options withBytesPerSecond(Long bytesPerSecond)
A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of
1 MB, set this value to 1048576 (=1024*1024).
bytesPerSecond - A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a
maximum of 1 MB, set this value to 1048576 (=1024*1024).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 queue-task-execution.
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 queue-task-execution.
TaskQueueingpublic 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 queue-task-execution.
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 queue-task-execution.
TaskQueueingpublic 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 queue-task-execution.
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 queue-task-execution.
TaskQueueingpublic 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 queue-task-execution.
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 queue-task-execution.
TaskQueueingpublic 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.
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.LogLevelpublic 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.
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.LogLevelpublic 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.
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.LogLevelpublic 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.
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.LogLevelpublic 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.
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.
TransferModepublic 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.
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.
TransferModepublic 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.
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.
TransferModepublic 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.
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.
TransferModepublic String toString()
toString in class ObjectObject.toString()public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.