Options class

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.

Constructors

Options({Atime? atime, int? bytesPerSecond, Gid? gid, LogLevel? logLevel, Mtime? mtime, OverwriteMode? overwriteMode, PosixPermissions? posixPermissions, PreserveDeletedFiles? preserveDeletedFiles, PreserveDevices? preserveDevices, TaskQueueing? taskQueueing, TransferMode? transferMode, Uid? uid, VerifyMode? verifyMode})
Options.fromJson(Map<String, dynamic> json)
factory

Properties

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.
final
bytesPerSecond → int?
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).
final
gid → Gid?
The group ID (GID) of the file's owners.
final
hashCode → int
The hash code for this object.
no setterinherited
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.
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.
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.
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.
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.
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. Default value: NONE.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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.
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.
final
uid → Uid?
The user ID (UID) of the file's owner.
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
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited