@Generated(value="software.amazon.awssdk:codegen") public final class Options extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Options.Builder,Options>
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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Options.Builder |
| Modifier and Type | Method and Description |
|---|---|
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).
|
String |
atimeAsString()
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written
to).
|
static Options.Builder |
builder() |
Long |
bytesPerSecond()
A value that limits the bandwidth used by AWS DataSync.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Gid |
gid()
The group ID (GID) of the file's owners.
|
String |
gidAsString()
The group ID (GID) of the file's owners.
|
int |
hashCode() |
LogLevel |
logLevel()
A value that determines the type of logs DataSync will deliver to your AWS CloudWatch Logs file.
|
String |
logLevelAsString()
A value that determines the type of logs DataSync will deliver to your AWS CloudWatch Logs file.
|
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.
|
String |
mtimeAsString()
A value that indicates the last time that a file was modified (that is, a file was written to) before the
PREPARING phase.
|
OverwriteMode |
overwriteMode()
A value that determines whether files at the destination should be overwritten or preserved when copying files.
|
String |
overwriteModeAsString()
A value that determines whether files at the destination should be overwritten or preserved when copying files.
|
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.
|
String |
posixPermissionsAsString()
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.
|
PreserveDeletedFiles |
preserveDeletedFiles()
A value that specifies whether files in the destination that don't exist in the source file system should be
preserved.
|
String |
preserveDeletedFilesAsString()
A value that specifies whether files in the destination that don't exist in the source file system should be
preserved.
|
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.
|
String |
preserveDevicesAsString()
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Options.Builder> |
serializableBuilderClass() |
TaskQueueing |
taskQueueing()
A value that determines whether tasks should be queued before executing the tasks.
|
String |
taskQueueingAsString()
A value that determines whether tasks should be queued before executing the tasks.
|
Options.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Uid |
uid()
The user ID (UID) of the file's owner.
|
String |
uidAsString()
The user ID (UID) of the file's owner.
|
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.
|
String |
verifyModeAsString()
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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
If the service returns an enum value that is not available in the current SDK version, verifyMode will
return VerifyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
verifyModeAsString().
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
VerifyModepublic String verifyModeAsString()
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.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
If the service returns an enum value that is not available in the current SDK version, verifyMode will
return VerifyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
verifyModeAsString().
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
NONE: Skip verification.
VerifyModepublic 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.
If the service returns an enum value that is not available in the current SDK version, overwriteMode
will return OverwriteMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
overwriteModeAsString().
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 overwriteModeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, overwriteMode
will return OverwriteMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
overwriteModeAsString().
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 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.
If the service returns an enum value that is not available in the current SDK version, atime will return
Atime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
atimeAsString().
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 atimeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, atime will return
Atime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
atimeAsString().
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 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.
If the service returns an enum value that is not available in the current SDK version, mtime will return
Mtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
mtimeAsString().
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 mtimeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, mtime will return
Mtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
mtimeAsString().
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 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.
If the service returns an enum value that is not available in the current SDK version, uid will return
Uid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uidAsString().
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 uidAsString()
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.
If the service returns an enum value that is not available in the current SDK version, uid will return
Uid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uidAsString().
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 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.
If the service returns an enum value that is not available in the current SDK version, gid will return
Gid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gidAsString().
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 gidAsString()
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.
If the service returns an enum value that is not available in the current SDK version, gid will return
Gid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gidAsString().
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 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.
If the service returns an enum value that is not available in the current SDK version,
preserveDeletedFiles will return PreserveDeletedFiles.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from preserveDeletedFilesAsString().
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDeletedFilespublic String preserveDeletedFilesAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
preserveDeletedFiles will return PreserveDeletedFiles.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from preserveDeletedFilesAsString().
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
PreserveDeletedFilespublic 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.
If the service returns an enum value that is not available in the current SDK version, preserveDevices
will return PreserveDevices.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from preserveDevicesAsString().
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 preserveDevicesAsString()
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.
If the service returns an enum value that is not available in the current SDK version, preserveDevices
will return PreserveDevices.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from preserveDevicesAsString().
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 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.
If the service returns an enum value that is not available in the current SDK version, posixPermissions
will return PosixPermissions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from posixPermissionsAsString().
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
PosixPermissionspublic String posixPermissionsAsString()
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.
If the service returns an enum value that is not available in the current SDK version, posixPermissions
will return PosixPermissions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from posixPermissionsAsString().
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
AWS DataSync can preserve extant permissions of a source location.
PosixPermissionspublic 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).
1048576 (=1024*1024).public 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.
If the service returns an enum value that is not available in the current SDK version, taskQueueing will
return TaskQueueing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
taskQueueingAsString().
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 taskQueueingAsString()
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.
If the service returns an enum value that is not available in the current SDK version, taskQueueing will
return TaskQueueing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
taskQueueingAsString().
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 LogLevel logLevel()
A value that determines the type of logs DataSync will deliver to your AWS CloudWatch Logs file. If set to
OFF, no logs will be delivered. BASIC will deliver a few logs per transfer operation
and TRANSFER will deliver a verbose log that contains logs for every file that is transferred.
If the service returns an enum value that is not available in the current SDK version, logLevel will
return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
logLevelAsString().
OFF, no logs will be delivered. BASIC will deliver a few logs per transfer
operation and TRANSFER will deliver a verbose log that contains logs for every file that is
transferred.LogLevelpublic String logLevelAsString()
A value that determines the type of logs DataSync will deliver to your AWS CloudWatch Logs file. If set to
OFF, no logs will be delivered. BASIC will deliver a few logs per transfer operation
and TRANSFER will deliver a verbose log that contains logs for every file that is transferred.
If the service returns an enum value that is not available in the current SDK version, logLevel will
return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
logLevelAsString().
OFF, no logs will be delivered. BASIC will deliver a few logs per transfer
operation and TRANSFER will deliver a verbose log that contains logs for every file that is
transferred.LogLevelpublic Options.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<Options.Builder,Options>public static Options.Builder builder()
public static Class<? extends Options.Builder> serializableBuilderClass()
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic String toString()
Copyright © 2020. All rights reserved.