software.amazon.awssdk.services.datasync.model

Class Options

java.lang.Object

software.amazon.awssdk.services.datasync.model.Options

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Options.Builder,Options>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Options.Builder

Method Summary

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 that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
String	logLevelAsString() A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
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.
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.
String	transferModeAsString() 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.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

verifyMode

public final 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.

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().

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 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.

See Also:

VerifyMode

verifyModeAsString

public final 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. 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.

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().

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 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.

See Also:

VerifyMode

overwriteMode

public final 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().

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 using-storage-classes in the AWS DataSync User Guide.

See Also:

OverwriteMode

overwriteModeAsString

public final 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().

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 using-storage-classes in the AWS DataSync User Guide.

See Also:

OverwriteMode

atime

public final 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().

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 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.

See Also:

Atime

atimeAsString

public final 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().

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 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.

See Also:

Atime

mtime

public final 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().

Returns:

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.

See Also:

Mtime

mtimeAsString

public final 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().

Returns:

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.

See Also:

Mtime

uid

public final 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().

Returns:

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.

See Also:

Uid

uidAsString

public final 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().

Returns:

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.

See Also:

Uid

gid

public final 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().

Returns:

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.

See Also:

Gid

gidAsString

public final 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().

Returns:

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.

See Also:

Gid

preserveDeletedFiles

public final 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().

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 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.

See Also:

PreserveDeletedFiles

preserveDeletedFilesAsString

public final 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().

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 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.

See Also:

PreserveDeletedFiles

preserveDevices

public final 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().

Returns:

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.

See Also:

PreserveDevices

preserveDevicesAsString

public final 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().

Returns:

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.

See Also:

PreserveDevices

posixPermissions

public final 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().

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.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

See Also:

PosixPermissions

posixPermissionsAsString

public final 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().

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.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

See Also:

PosixPermissions

bytesPerSecond

public final 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).

Returns:

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).

taskQueueing

public final 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().

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 queue-task-execution.

See Also:

TaskQueueing

taskQueueingAsString

public final 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().

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 queue-task-execution.

See Also:

TaskQueueing

logLevel

public final 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.

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().

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

logLevelAsString

public final String logLevelAsString()

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.

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().

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

transferMode

public final 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.

If the service returns an enum value that is not available in the current SDK version, transferMode will return TransferMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transferModeAsString().

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

transferModeAsString

public final String transferModeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, transferMode will return TransferMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transferModeAsString().

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

toBuilder

public Options.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Options.Builder,Options>

builder

public static Options.Builder builder()

serializableBuilderClass

public static Class<? extends Options.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo