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)
<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()
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.
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()
Options.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

verifyMode

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

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

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.

Default value: POINT_IN_TIME_CONSISTENT.

POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

NONE: Skip verification.

See Also:

VerifyMode

verifyModeAsString

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

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

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.

Default value: POINT_IN_TIME_CONSISTENT.

POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

NONE: Skip verification.

See Also:

VerifyMode

atime

public 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 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 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 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 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 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 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 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 PreserveDeletedFiles preserveDeletedFiles()

A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

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.

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 String preserveDeletedFilesAsString()

A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

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.

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

toBuilder

public Options.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Options.Builder,Options>

Returns:

a builder for type T

builder

public static Options.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.