software.amazon.awssdk.services.datasync.model

Interface Options.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Options.Builder,Options>, SdkBuilder<Options.Builder,Options>, SdkPojo

Enclosing class:

Options

public static interface Options.Builder
extends SdkPojo, CopyableBuilder<Options.Builder,Options>

Method Summary

Modifier and Type	Method and Description
Options.Builder	atime(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.Builder	atime(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.Builder	bytesPerSecond(Long bytesPerSecond) A value that limits the bandwidth used by AWS DataSync.
Options.Builder	gid(Gid gid) The group ID (GID) of the file's owners.
Options.Builder	gid(String gid) The group ID (GID) of the file's owners.
Options.Builder	mtime(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.Builder	mtime(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.Builder	overwriteMode(OverwriteMode overwriteMode) A value that determines whether files at the destination should be overwritten or preserved when copying files.
Options.Builder	overwriteMode(String overwriteMode) A value that determines whether files at the destination should be overwritten or preserved when copying files.
Options.Builder	posixPermissions(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.Builder	posixPermissions(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.Builder	preserveDeletedFiles(PreserveDeletedFiles preserveDeletedFiles) A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
Options.Builder	preserveDeletedFiles(String preserveDeletedFiles) A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
Options.Builder	preserveDevices(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.Builder	preserveDevices(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.Builder	taskQueueing(String taskQueueing) A value that determines whether tasks should be queued before executing the tasks.
Options.Builder	taskQueueing(TaskQueueing taskQueueing) A value that determines whether tasks should be queued before executing the tasks.
Options.Builder	uid(String uid) The user ID (UID) of the file's owner.
Options.Builder	uid(Uid uid) The user ID (UID) of the file's owner.
Options.Builder	verifyMode(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.Builder	verifyMode(VerifyMode verifyMode) A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

verifyMode

Options.Builder verifyMode(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.

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.

Parameters:

verifyMode - A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerifyMode, VerifyMode

verifyMode

Options.Builder verifyMode(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.

Parameters:

verifyMode - A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerifyMode, VerifyMode

overwriteMode

Options.Builder overwriteMode(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.

Parameters:

overwriteMode - A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OverwriteMode, OverwriteMode

overwriteMode

Options.Builder overwriteMode(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.

Parameters:

overwriteMode - A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OverwriteMode, OverwriteMode

atime

Options.Builder atime(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.

Parameters:

atime - A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Atime, Atime

atime

Options.Builder atime(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.

Parameters:

atime - A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Atime, Atime

mtime

Options.Builder mtime(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.

Parameters:

mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mtime, Mtime

mtime

Options.Builder mtime(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.

Parameters:

mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mtime, Mtime

uid

Options.Builder uid(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Uid, Uid

uid

Options.Builder uid(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Uid, Uid

gid

Options.Builder gid(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Gid, Gid

gid

Options.Builder gid(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Gid, Gid

preserveDeletedFiles

Options.Builder preserveDeletedFiles(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.

Parameters:

preserveDeletedFiles - A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PreserveDeletedFiles, PreserveDeletedFiles

preserveDeletedFiles

Options.Builder preserveDeletedFiles(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.

Parameters:

preserveDeletedFiles - A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PreserveDeletedFiles, PreserveDeletedFiles

preserveDevices

Options.Builder preserveDevices(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PreserveDevices, PreserveDevices

preserveDevices

Options.Builder preserveDevices(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PreserveDevices, PreserveDevices

posixPermissions

Options.Builder posixPermissions(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.

Parameters:

posixPermissions - A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PosixPermissions, PosixPermissions

posixPermissions

Options.Builder posixPermissions(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.

Parameters:

posixPermissions - A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PosixPermissions, PosixPermissions

bytesPerSecond

Options.Builder bytesPerSecond(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

taskQueueing

Options.Builder taskQueueing(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.

Parameters:

taskQueueing - A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see queue-task-execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskQueueing, TaskQueueing

taskQueueing

Options.Builder taskQueueing(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.

Parameters:

taskQueueing - A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see queue-task-execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskQueueing, TaskQueueing