com.amazonaws.services.datasync.model.Options Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datasync Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.datasync.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their
* associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for
* your task, among other options.
*
*
* Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.
*
*
* You also can override your task options for each task execution. For example, you might want to adjust the
* LogLevel for an individual execution.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Options implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and
* metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum
* calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire source
* and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
*
*/
private String verifyMode;
/**
*
* Specifies whether DataSync should modify or preserve data at the destination location.
*
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data (including
* metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for
* example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data has
* changed. You can use this option to protect against overwriting changes made to files or objects in the
* destination.
*
*
*
*/
private String overwriteMode;
/**
*
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
*
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a
* best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on
* all source files (that is, the version before the PREPARING phase of the task execution). This
* option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*/
private String atime;
/**
*
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a task more
* than once.
*
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*/
private String mtime;
/**
*
* Specifies the POSIX user ID (UID) of the file's owner.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*/
private String uid;
/**
*
* Specifies the POSIX group ID (GID) of the file's owners.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*/
private String gid;
/**
*
* Specifies whether files in the destination location that don't exist in the source should be preserved. This
* option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage
* duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to ALL.
* When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
*
*
*/
private String preserveDeletedFiles;
/**
*
* Specifies whether DataSync should preserve the metadata of block and character devices in the source location and
* recreate the files with that device name and metadata on the destination. DataSync copies only the name and
* metadata of such devices.
*
*
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't supported for
* Amazon EFS.
*
*
*
*/
private String preserveDevices;
/**
*
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution
* of the file.
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
*
*/
private String posixPermissions;
/**
*
* Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set
* this value to 1048576 (=1024*1024).
*
*/
private Long bytesPerSecond;
/**
*
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
*
*/
private String taskQueueing;
/**
*
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log
* group, see CloudWatchLogGroupArn.
*
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs
* data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
*
*/
private String logLevel;
/**
*
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the destination).
*
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content from the
* source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing differences
* between the locations.
*
*
*
*/
private String transferMode;
/**
*
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two
* FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB
* location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx
* for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are owned by
* the user that was provided for accessing the destination location. DACLs and SACLs are set based on the
* destination server’s configuration.
*
*
*
*/
private String securityDescriptorCopyFlags;
/**
*
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring
* between object storage systems. If you want your DataSync task to ignore object tags, specify the
* NONE value.
*
*/
private String objectTags;
/**
*
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and
* metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum
* calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire source
* and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
*
*
* @param verifyMode
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files
* and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to
* the checksum calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire
* source and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
* @see VerifyMode
*/
public void setVerifyMode(String verifyMode) {
this.verifyMode = verifyMode;
}
/**
*
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and
* metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum
* calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire source
* and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
*
*
* @return Specifies how and when DataSync checks the integrity of your data during a transfer.
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files
* and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to
* the checksum calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire
* source and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest, DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
* @see VerifyMode
*/
public String getVerifyMode() {
return this.verifyMode;
}
/**
*
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and
* metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum
* calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire source
* and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
*
*
* @param verifyMode
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files
* and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to
* the checksum calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire
* source and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see VerifyMode
*/
public Options withVerifyMode(String verifyMode) {
setVerifyMode(verifyMode);
return this;
}
/**
*
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and
* metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum
* calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire source
* and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
* classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
*
*
* @param verifyMode
* Specifies how and when DataSync checks the integrity of your data during a transfer.
*
* -
*
* ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files
* and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to
* the checksum calculated on those files at the destination.
*
*
* We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire
* source and destination to verify that both locations are fully synchronized.
*
*
* If you use a manifest,
* DataSync only scans and verifies what's listed in the manifest.
*
*
* You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive
* storage classes. For more information, see Storage class considerations with Amazon S3 locations.
*
*
* -
*
* NONE - DataSync doesn't run additional verification at the end of the transfer. All data
* transmissions are still integrity-checked with checksum verification during the transfer.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see VerifyMode
*/
public Options withVerifyMode(VerifyMode verifyMode) {
this.verifyMode = verifyMode.toString();
return this;
}
/**
*
* Specifies whether DataSync should modify or preserve data at the destination location.
*
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data (including
* metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for
* example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data has
* changed. You can use this option to protect against overwriting changes made to files or objects in the
* destination.
*
*
*
*
* @param overwriteMode
* Specifies whether DataSync should modify or preserve data at the destination location.
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data
* (including metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes
* (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data
* has changed. You can use this option to protect against overwriting changes made to files or objects in
* the destination.
*
*
* @see OverwriteMode
*/
public void setOverwriteMode(String overwriteMode) {
this.overwriteMode = overwriteMode;
}
/**
*
* Specifies whether DataSync should modify or preserve data at the destination location.
*
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data (including
* metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for
* example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data has
* changed. You can use this option to protect against overwriting changes made to files or objects in the
* destination.
*
*
*
*
* @return Specifies whether DataSync should modify or preserve data at the destination location.
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data
* (including metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes
* (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data
* has changed. You can use this option to protect against overwriting changes made to files or objects in
* the destination.
*
*
* @see OverwriteMode
*/
public String getOverwriteMode() {
return this.overwriteMode;
}
/**
*
* Specifies whether DataSync should modify or preserve data at the destination location.
*
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data (including
* metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for
* example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data has
* changed. You can use this option to protect against overwriting changes made to files or objects in the
* destination.
*
*
*
*
* @param overwriteMode
* Specifies whether DataSync should modify or preserve data at the destination location.
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data
* (including metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes
* (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data
* has changed. You can use this option to protect against overwriting changes made to files or objects in
* the destination.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see OverwriteMode
*/
public Options withOverwriteMode(String overwriteMode) {
setOverwriteMode(overwriteMode);
return this;
}
/**
*
* Specifies whether DataSync should modify or preserve data at the destination location.
*
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data (including
* metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for
* example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data has
* changed. You can use this option to protect against overwriting changes made to files or objects in the
* destination.
*
*
*
*
* @param overwriteMode
* Specifies whether DataSync should modify or preserve data at the destination location.
*
* -
*
* ALWAYS (default) - DataSync modifies data in the destination location when source data
* (including metadata) has changed.
*
*
* If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes
* (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
*
*
* -
*
* NEVER - DataSync doesn't overwrite data in the destination location even if the source data
* has changed. You can use this option to protect against overwriting changes made to files or objects in
* the destination.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see OverwriteMode
*/
public Options withOverwriteMode(OverwriteMode overwriteMode) {
this.overwriteMode = overwriteMode.toString();
return this;
}
/**
*
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
*
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a
* best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on
* all source files (that is, the version before the PREPARING phase of the task execution). This
* option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @param atime
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on
* a best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime
* attribute on all source files (that is, the version before the PREPARING phase of the task
* execution). This option is recommended.
*
*
* -
*
* NONE - Ignores 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 Atime
*/
public void setAtime(String atime) {
this.atime = atime;
}
/**
*
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
*
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a
* best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on
* all source files (that is, the version before the PREPARING phase of the task execution). This
* option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @return Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on
* a best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime
* attribute on all source files (that is, the version before the PREPARING phase of the task
* execution). This option is recommended.
*
*
* -
*
* NONE - Ignores 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 Atime
*/
public String getAtime() {
return this.atime;
}
/**
*
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
*
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a
* best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on
* all source files (that is, the version before the PREPARING phase of the task execution). This
* option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @param atime
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on
* a best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime
* attribute on all source files (that is, the version before the PREPARING phase of the task
* execution). This option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Atime
*/
public Options withAtime(String atime) {
setAtime(atime);
return this;
}
/**
*
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
*
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a
* best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on
* all source files (that is, the version before the PREPARING phase of the task execution). This
* option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @param atime
* Specifies whether to preserve metadata indicating the last time a file was read or written to.
*
* The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on
* a best-effort basis.
*
*
*
* -
*
* BEST_EFFORT (default) - DataSync attempts to preserve the original Atime
* attribute on all source files (that is, the version before the PREPARING phase of the task
* execution). This option is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Atime
*/
public Options withAtime(Atime atime) {
this.atime = atime.toString();
return this;
}
/**
*
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a task more
* than once.
*
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @param mtime
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a
* task more than once.
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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 Mtime
*/
public void setMtime(String mtime) {
this.mtime = mtime;
}
/**
*
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a task more
* than once.
*
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @return Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a
* task more than once.
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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 Mtime
*/
public String getMtime() {
return this.mtime;
}
/**
*
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a task more
* than once.
*
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @param mtime
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a
* task more than once.
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mtime
*/
public Options withMtime(String mtime) {
setMtime(mtime);
return this;
}
/**
*
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a task more
* than once.
*
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
*
*
* @param mtime
* Specifies whether to preserve metadata indicating the last time that a file was written to before the
* PREPARING phase of your task execution. This option is required when you need to run the a
* task more than once.
*
* -
*
* PRESERVE (default) - Preserves original Mtime, which is recommended.
*
*
* -
*
* NONE - Ignores 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mtime
*/
public Options withMtime(Mtime mtime) {
this.mtime = mtime.toString();
return this;
}
/**
*
* Specifies the POSIX user ID (UID) of the file's owner.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @param uid
* Specifies the POSIX user ID (UID) of the file's owner.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @see Uid
*/
public void setUid(String uid) {
this.uid = uid;
}
/**
*
* Specifies the POSIX user ID (UID) of the file's owner.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @return Specifies the POSIX user ID (UID) of the file's owner.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @see Uid
*/
public String getUid() {
return this.uid;
}
/**
*
* Specifies the POSIX user ID (UID) of the file's owner.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @param uid
* Specifies the POSIX user ID (UID) of the file's owner.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Uid
*/
public Options withUid(String uid) {
setUid(uid);
return this;
}
/**
*
* Specifies the POSIX user ID (UID) of the file's owner.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @param uid
* Specifies the POSIX user ID (UID) of the file's owner.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Uid
*/
public Options withUid(Uid uid) {
this.uid = uid.toString();
return this;
}
/**
*
* Specifies the POSIX group ID (GID) of the file's owners.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @param gid
* Specifies the POSIX group ID (GID) of the file's owners.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @see Gid
*/
public void setGid(String gid) {
this.gid = gid;
}
/**
*
* Specifies the POSIX group ID (GID) of the file's owners.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @return Specifies the POSIX group ID (GID) of the file's owners.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @see Gid
*/
public String getGid() {
return this.gid;
}
/**
*
* Specifies the POSIX group ID (GID) of the file's owners.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @param gid
* Specifies the POSIX group ID (GID) of the file's owners.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Gid
*/
public Options withGid(String gid) {
setGid(gid);
return this;
}
/**
*
* Specifies the POSIX group ID (GID) of the file's owners.
*
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* @param gid
* Specifies the POSIX group ID (GID) of the file's owners.
*
* -
*
* INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is
* recommended.
*
*
* -
*
* NONE - Ignores UID and GID.
*
*
*
*
* For more information, see Metadata
* copied by DataSync.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Gid
*/
public Options withGid(Gid gid) {
this.gid = gid.toString();
return this;
}
/**
*
* Specifies whether files in the destination location that don't exist in the source should be preserved. This
* option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage
* duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to ALL.
* When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
*
*
*
* @param preserveDeletedFiles
* Specifies whether files in the destination location that don't exist in the source should be preserved.
* This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum
* storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to
* ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't
* know what to delete.
*
* @see PreserveDeletedFiles
*/
public void setPreserveDeletedFiles(String preserveDeletedFiles) {
this.preserveDeletedFiles = preserveDeletedFiles;
}
/**
*
* Specifies whether files in the destination location that don't exist in the source should be preserved. This
* option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage
* duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to ALL.
* When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
*
*
*
* @return Specifies whether files in the destination location that don't exist in the source should be preserved.
* This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum
* storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to
* ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't
* know what to delete.
*
* @see PreserveDeletedFiles
*/
public String getPreserveDeletedFiles() {
return this.preserveDeletedFiles;
}
/**
*
* Specifies whether files in the destination location that don't exist in the source should be preserved. This
* option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage
* duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to ALL.
* When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
*
*
*
* @param preserveDeletedFiles
* Specifies whether files in the destination location that don't exist in the source should be preserved.
* This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum
* storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to
* ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't
* know what to delete.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PreserveDeletedFiles
*/
public Options withPreserveDeletedFiles(String preserveDeletedFiles) {
setPreserveDeletedFiles(preserveDeletedFiles);
return this;
}
/**
*
* Specifies whether files in the destination location that don't exist in the source should be preserved. This
* option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage
* duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to ALL.
* When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.
*
*
*
* @param preserveDeletedFiles
* Specifies whether files in the destination location that don't exist in the source should be preserved.
* This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum
* storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
*
* -
*
* PRESERVE (default) - Ignores such destination files, which is recommended.
*
*
* -
*
* REMOVE - Deletes destination files that aren’t present in the source.
*
*
*
*
*
* If you set this parameter to REMOVE, you can't set TransferMode to
* ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't
* know what to delete.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PreserveDeletedFiles
*/
public Options withPreserveDeletedFiles(PreserveDeletedFiles preserveDeletedFiles) {
this.preserveDeletedFiles = preserveDeletedFiles.toString();
return this;
}
/**
*
* Specifies whether DataSync should preserve the metadata of block and character devices in the source location and
* recreate the files with that device name and metadata on the destination. DataSync copies only the name and
* metadata of such devices.
*
*
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't supported for
* Amazon EFS.
*
*
*
*
* @param preserveDevices
* Specifies whether DataSync should preserve the metadata of block and character devices in the source
* location and recreate the files with that device name and metadata on the destination. DataSync copies
* only the name and metadata of such devices.
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't
* supported for Amazon EFS.
*
*
* @see PreserveDevices
*/
public void setPreserveDevices(String preserveDevices) {
this.preserveDevices = preserveDevices;
}
/**
*
* Specifies whether DataSync should preserve the metadata of block and character devices in the source location and
* recreate the files with that device name and metadata on the destination. DataSync copies only the name and
* metadata of such devices.
*
*
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't supported for
* Amazon EFS.
*
*
*
*
* @return Specifies whether DataSync should preserve the metadata of block and character devices in the source
* location and recreate the files with that device name and metadata on the destination. DataSync copies
* only the name and metadata of such devices.
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't
* supported for Amazon EFS.
*
*
* @see PreserveDevices
*/
public String getPreserveDevices() {
return this.preserveDevices;
}
/**
*
* Specifies whether DataSync should preserve the metadata of block and character devices in the source location and
* recreate the files with that device name and metadata on the destination. DataSync copies only the name and
* metadata of such devices.
*
*
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't supported for
* Amazon EFS.
*
*
*
*
* @param preserveDevices
* Specifies whether DataSync should preserve the metadata of block and character devices in the source
* location and recreate the files with that device name and metadata on the destination. DataSync copies
* only the name and metadata of such devices.
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't
* supported for Amazon EFS.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PreserveDevices
*/
public Options withPreserveDevices(String preserveDevices) {
setPreserveDevices(preserveDevices);
return this;
}
/**
*
* Specifies whether DataSync should preserve the metadata of block and character devices in the source location and
* recreate the files with that device name and metadata on the destination. DataSync copies only the name and
* metadata of such devices.
*
*
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't supported for
* Amazon EFS.
*
*
*
*
* @param preserveDevices
* Specifies whether DataSync should preserve the metadata of block and character devices in the source
* location and recreate the files with that device name and metadata on the destination. DataSync copies
* only the name and metadata of such devices.
*
* DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an
* end-of-file (EOF) marker.
*
*
*
* -
*
* NONE (default) - Ignores special devices (recommended).
*
*
* -
*
* PRESERVE - Preserves character and block device metadata. This option currently isn't
* supported for Amazon EFS.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PreserveDevices
*/
public Options withPreserveDevices(PreserveDevices preserveDevices) {
this.preserveDevices = preserveDevices.toString();
return this;
}
/**
*
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution
* of the file.
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
*
*
* @param posixPermissions
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or
* execution of the file.
*
* For more information, see Metadata
* copied by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
* @see PosixPermissions
*/
public void setPosixPermissions(String posixPermissions) {
this.posixPermissions = posixPermissions;
}
/**
*
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution
* of the file.
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
*
*
* @return Specifies which users or groups can access a file for a specific purpose such as reading, writing, or
* execution of the file.
*
* For more information, see Metadata
* copied by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
* @see PosixPermissions
*/
public String getPosixPermissions() {
return this.posixPermissions;
}
/**
*
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution
* of the file.
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
*
*
* @param posixPermissions
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or
* execution of the file.
*
* For more information, see Metadata
* copied by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PosixPermissions
*/
public Options withPosixPermissions(String posixPermissions) {
setPosixPermissions(posixPermissions);
return this;
}
/**
*
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution
* of the file.
*
*
* For more information, see Metadata copied
* by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
*
*
* @param posixPermissions
* Specifies which users or groups can access a file for a specific purpose such as reading, writing, or
* execution of the file.
*
* For more information, see Metadata
* copied by DataSync.
*
*
* -
*
* PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
*
*
* -
*
* NONE - Ignores POSIX-style permissions.
*
*
*
*
*
* DataSync can preserve extant permissions of a source location.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PosixPermissions
*/
public Options withPosixPermissions(PosixPermissions posixPermissions) {
this.posixPermissions = posixPermissions.toString();
return this;
}
/**
*
* Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set
* this value to 1048576 (=1024*1024).
*
*
* @param bytesPerSecond
* Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB,
* set this value to 1048576 (=1024*1024).
*/
public void setBytesPerSecond(Long bytesPerSecond) {
this.bytesPerSecond = bytesPerSecond;
}
/**
*
* Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set
* this value to 1048576 (=1024*1024).
*
*
* @return Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB,
* set this value to 1048576 (=1024*1024).
*/
public Long getBytesPerSecond() {
return this.bytesPerSecond;
}
/**
*
* Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set
* this value to 1048576 (=1024*1024).
*
*
* @param bytesPerSecond
* Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB,
* set this value to 1048576 (=1024*1024).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Options withBytesPerSecond(Long bytesPerSecond) {
setBytesPerSecond(bytesPerSecond);
return this;
}
/**
*
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
*
*
* @param taskQueueing
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
* @see TaskQueueing
*/
public void setTaskQueueing(String taskQueueing) {
this.taskQueueing = taskQueueing;
}
/**
*
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
*
*
* @return Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
* @see TaskQueueing
*/
public String getTaskQueueing() {
return this.taskQueueing;
}
/**
*
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
*
*
* @param taskQueueing
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaskQueueing
*/
public Options withTaskQueueing(String taskQueueing) {
setTaskQueueing(taskQueueing);
return this;
}
/**
*
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
*
*
* @param taskQueueing
* Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
* multiple tasks. This is ENABLED by default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaskQueueing
*/
public Options withTaskQueueing(TaskQueueing taskQueueing) {
this.taskQueueing = taskQueueing.toString();
return this;
}
/**
*
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log
* group, see CloudWatchLogGroupArn.
*
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs
* data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
*
*
* @param logLevel
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the
* log group, see CloudWatchLogGroupArn.
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and
* performs data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
* @see LogLevel
*/
public void setLogLevel(String logLevel) {
this.logLevel = logLevel;
}
/**
*
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log
* group, see CloudWatchLogGroupArn.
*
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs
* data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
*
*
* @return Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the
* log group, see CloudWatchLogGroupArn.
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and
* performs data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
* @see LogLevel
*/
public String getLogLevel() {
return this.logLevel;
}
/**
*
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log
* group, see CloudWatchLogGroupArn.
*
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs
* data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
*
*
* @param logLevel
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the
* log group, see CloudWatchLogGroupArn.
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and
* performs data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see LogLevel
*/
public Options withLogLevel(String logLevel) {
setLogLevel(logLevel);
return this;
}
/**
*
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log
* group, see CloudWatchLogGroupArn.
*
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs
* data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
*
*
* @param logLevel
* Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the
* log group, see CloudWatchLogGroupArn.
*
* -
*
* BASIC - Publishes logs with only basic information (such as transfer errors).
*
*
* -
*
* TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and
* performs data-integrity checks on.
*
*
* -
*
* OFF - No logs are published.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see LogLevel
*/
public Options withLogLevel(LogLevel logLevel) {
this.logLevel = logLevel.toString();
return this;
}
/**
*
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the destination).
*
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content from the
* source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing differences
* between the locations.
*
*
*
*
* @param transferMode
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the
* destination).
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content
* from the source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing
* differences between the locations.
*
*
* @see TransferMode
*/
public void setTransferMode(String transferMode) {
this.transferMode = transferMode;
}
/**
*
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the destination).
*
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content from the
* source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing differences
* between the locations.
*
*
*
*
* @return Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the
* destination).
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content
* from the source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing
* differences between the locations.
*
*
* @see TransferMode
*/
public String getTransferMode() {
return this.transferMode;
}
/**
*
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the destination).
*
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content from the
* source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing differences
* between the locations.
*
*
*
*
* @param transferMode
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the
* destination).
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content
* from the source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing
* differences between the locations.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransferMode
*/
public Options withTransferMode(String transferMode) {
setTransferMode(transferMode);
return this;
}
/**
*
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the destination).
*
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content from the
* source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing differences
* between the locations.
*
*
*
*
* @param transferMode
* Determines whether DataSync transfers only the data and metadata that differ between the source and the
* destination location or transfers all the content from the source (without comparing what's in the
* destination).
*
* -
*
* CHANGED (default) - DataSync copies only data or metadata that is new or different content
* from the source location to the destination location.
*
*
* -
*
* ALL - DataSync copies everything in the source to the destination without comparing
* differences between the locations.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransferMode
*/
public Options withTransferMode(TransferMode transferMode) {
this.transferMode = transferMode.toString();
return this;
}
/**
*
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two
* FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB
* location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx
* for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are owned by
* the user that was provided for accessing the destination location. DACLs and SACLs are set based on the
* destination server’s configuration.
*
*
*
*
* @param securityDescriptorCopyFlags
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or
* between two FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access
* your SMB location. For information about choosing a user with the right permissions, see required
* permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are
* owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based
* on the destination server’s configuration.
*
*
* @see SmbSecurityDescriptorCopyFlags
*/
public void setSecurityDescriptorCopyFlags(String securityDescriptorCopyFlags) {
this.securityDescriptorCopyFlags = securityDescriptorCopyFlags;
}
/**
*
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two
* FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB
* location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx
* for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are owned by
* the user that was provided for accessing the destination location. DACLs and SACLs are set based on the
* destination server’s configuration.
*
*
*
*
* @return Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or
* between two FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access
* your SMB location. For information about choosing a user with the right permissions, see required
* permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are
* owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based
* on the destination server’s configuration.
*
*
* @see SmbSecurityDescriptorCopyFlags
*/
public String getSecurityDescriptorCopyFlags() {
return this.securityDescriptorCopyFlags;
}
/**
*
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two
* FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB
* location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx
* for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are owned by
* the user that was provided for accessing the destination location. DACLs and SACLs are set based on the
* destination server’s configuration.
*
*
*
*
* @param securityDescriptorCopyFlags
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or
* between two FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access
* your SMB location. For information about choosing a user with the right permissions, see required
* permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are
* owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based
* on the destination server’s configuration.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SmbSecurityDescriptorCopyFlags
*/
public Options withSecurityDescriptorCopyFlags(String securityDescriptorCopyFlags) {
setSecurityDescriptorCopyFlags(securityDescriptorCopyFlags);
return this;
}
/**
*
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two
* FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB
* location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx
* for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are owned by
* the user that was provided for accessing the destination location. DACLs and SACLs are set based on the
* destination server’s configuration.
*
*
*
*
* @param securityDescriptorCopyFlags
* Specifies which components of the SMB security descriptor are copied from source to destination objects.
*
*
* This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or
* between two FSx for Windows File Server locations. For more information, see how DataSync handles
* metadata.
*
*
* -
*
* OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* DataSync won't copy NTFS system access control lists (SACLs) with this option.
*
*
*
*
* -
*
* OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
*
*
* -
*
* The object owner.
*
*
* -
*
* NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
*
*
* -
*
* SACLs, which are used by administrators to log attempts to access a secured object.
*
*
* Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access
* your SMB location. For information about choosing a user with the right permissions, see required
* permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).
*
*
*
*
* -
*
* NONE - None of the SMB security descriptor components are copied. Destination objects are
* owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based
* on the destination server’s configuration.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SmbSecurityDescriptorCopyFlags
*/
public Options withSecurityDescriptorCopyFlags(SmbSecurityDescriptorCopyFlags securityDescriptorCopyFlags) {
this.securityDescriptorCopyFlags = securityDescriptorCopyFlags.toString();
return this;
}
/**
*
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring
* between object storage systems. If you want your DataSync task to ignore object tags, specify the
* NONE value.
*
*
* @param objectTags
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when
* transferring between object storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE value.
* @see ObjectTags
*/
public void setObjectTags(String objectTags) {
this.objectTags = objectTags;
}
/**
*
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring
* between object storage systems. If you want your DataSync task to ignore object tags, specify the
* NONE value.
*
*
* @return Specifies whether you want DataSync to PRESERVE object tags (default behavior) when
* transferring between object storage systems. If you want your DataSync task to ignore object tags,
* specify the NONE value.
* @see ObjectTags
*/
public String getObjectTags() {
return this.objectTags;
}
/**
*
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring
* between object storage systems. If you want your DataSync task to ignore object tags, specify the
* NONE value.
*
*
* @param objectTags
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when
* transferring between object storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE value.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectTags
*/
public Options withObjectTags(String objectTags) {
setObjectTags(objectTags);
return this;
}
/**
*
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring
* between object storage systems. If you want your DataSync task to ignore object tags, specify the
* NONE value.
*
*
* @param objectTags
* Specifies whether you want DataSync to PRESERVE object tags (default behavior) when
* transferring between object storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE value.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectTags
*/
public Options withObjectTags(ObjectTags objectTags) {
this.objectTags = objectTags.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVerifyMode() != null)
sb.append("VerifyMode: ").append(getVerifyMode()).append(",");
if (getOverwriteMode() != null)
sb.append("OverwriteMode: ").append(getOverwriteMode()).append(",");
if (getAtime() != null)
sb.append("Atime: ").append(getAtime()).append(",");
if (getMtime() != null)
sb.append("Mtime: ").append(getMtime()).append(",");
if (getUid() != null)
sb.append("Uid: ").append(getUid()).append(",");
if (getGid() != null)
sb.append("Gid: ").append(getGid()).append(",");
if (getPreserveDeletedFiles() != null)
sb.append("PreserveDeletedFiles: ").append(getPreserveDeletedFiles()).append(",");
if (getPreserveDevices() != null)
sb.append("PreserveDevices: ").append(getPreserveDevices()).append(",");
if (getPosixPermissions() != null)
sb.append("PosixPermissions: ").append(getPosixPermissions()).append(",");
if (getBytesPerSecond() != null)
sb.append("BytesPerSecond: ").append(getBytesPerSecond()).append(",");
if (getTaskQueueing() != null)
sb.append("TaskQueueing: ").append(getTaskQueueing()).append(",");
if (getLogLevel() != null)
sb.append("LogLevel: ").append(getLogLevel()).append(",");
if (getTransferMode() != null)
sb.append("TransferMode: ").append(getTransferMode()).append(",");
if (getSecurityDescriptorCopyFlags() != null)
sb.append("SecurityDescriptorCopyFlags: ").append(getSecurityDescriptorCopyFlags()).append(",");
if (getObjectTags() != null)
sb.append("ObjectTags: ").append(getObjectTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Options == false)
return false;
Options other = (Options) obj;
if (other.getVerifyMode() == null ^ this.getVerifyMode() == null)
return false;
if (other.getVerifyMode() != null && other.getVerifyMode().equals(this.getVerifyMode()) == false)
return false;
if (other.getOverwriteMode() == null ^ this.getOverwriteMode() == null)
return false;
if (other.getOverwriteMode() != null && other.getOverwriteMode().equals(this.getOverwriteMode()) == false)
return false;
if (other.getAtime() == null ^ this.getAtime() == null)
return false;
if (other.getAtime() != null && other.getAtime().equals(this.getAtime()) == false)
return false;
if (other.getMtime() == null ^ this.getMtime() == null)
return false;
if (other.getMtime() != null && other.getMtime().equals(this.getMtime()) == false)
return false;
if (other.getUid() == null ^ this.getUid() == null)
return false;
if (other.getUid() != null && other.getUid().equals(this.getUid()) == false)
return false;
if (other.getGid() == null ^ this.getGid() == null)
return false;
if (other.getGid() != null && other.getGid().equals(this.getGid()) == false)
return false;
if (other.getPreserveDeletedFiles() == null ^ this.getPreserveDeletedFiles() == null)
return false;
if (other.getPreserveDeletedFiles() != null && other.getPreserveDeletedFiles().equals(this.getPreserveDeletedFiles()) == false)
return false;
if (other.getPreserveDevices() == null ^ this.getPreserveDevices() == null)
return false;
if (other.getPreserveDevices() != null && other.getPreserveDevices().equals(this.getPreserveDevices()) == false)
return false;
if (other.getPosixPermissions() == null ^ this.getPosixPermissions() == null)
return false;
if (other.getPosixPermissions() != null && other.getPosixPermissions().equals(this.getPosixPermissions()) == false)
return false;
if (other.getBytesPerSecond() == null ^ this.getBytesPerSecond() == null)
return false;
if (other.getBytesPerSecond() != null && other.getBytesPerSecond().equals(this.getBytesPerSecond()) == false)
return false;
if (other.getTaskQueueing() == null ^ this.getTaskQueueing() == null)
return false;
if (other.getTaskQueueing() != null && other.getTaskQueueing().equals(this.getTaskQueueing()) == false)
return false;
if (other.getLogLevel() == null ^ this.getLogLevel() == null)
return false;
if (other.getLogLevel() != null && other.getLogLevel().equals(this.getLogLevel()) == false)
return false;
if (other.getTransferMode() == null ^ this.getTransferMode() == null)
return false;
if (other.getTransferMode() != null && other.getTransferMode().equals(this.getTransferMode()) == false)
return false;
if (other.getSecurityDescriptorCopyFlags() == null ^ this.getSecurityDescriptorCopyFlags() == null)
return false;
if (other.getSecurityDescriptorCopyFlags() != null && other.getSecurityDescriptorCopyFlags().equals(this.getSecurityDescriptorCopyFlags()) == false)
return false;
if (other.getObjectTags() == null ^ this.getObjectTags() == null)
return false;
if (other.getObjectTags() != null && other.getObjectTags().equals(this.getObjectTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVerifyMode() == null) ? 0 : getVerifyMode().hashCode());
hashCode = prime * hashCode + ((getOverwriteMode() == null) ? 0 : getOverwriteMode().hashCode());
hashCode = prime * hashCode + ((getAtime() == null) ? 0 : getAtime().hashCode());
hashCode = prime * hashCode + ((getMtime() == null) ? 0 : getMtime().hashCode());
hashCode = prime * hashCode + ((getUid() == null) ? 0 : getUid().hashCode());
hashCode = prime * hashCode + ((getGid() == null) ? 0 : getGid().hashCode());
hashCode = prime * hashCode + ((getPreserveDeletedFiles() == null) ? 0 : getPreserveDeletedFiles().hashCode());
hashCode = prime * hashCode + ((getPreserveDevices() == null) ? 0 : getPreserveDevices().hashCode());
hashCode = prime * hashCode + ((getPosixPermissions() == null) ? 0 : getPosixPermissions().hashCode());
hashCode = prime * hashCode + ((getBytesPerSecond() == null) ? 0 : getBytesPerSecond().hashCode());
hashCode = prime * hashCode + ((getTaskQueueing() == null) ? 0 : getTaskQueueing().hashCode());
hashCode = prime * hashCode + ((getLogLevel() == null) ? 0 : getLogLevel().hashCode());
hashCode = prime * hashCode + ((getTransferMode() == null) ? 0 : getTransferMode().hashCode());
hashCode = prime * hashCode + ((getSecurityDescriptorCopyFlags() == null) ? 0 : getSecurityDescriptorCopyFlags().hashCode());
hashCode = prime * hashCode + ((getObjectTags() == null) ? 0 : getObjectTags().hashCode());
return hashCode;
}
@Override
public Options clone() {
try {
return (Options) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.datasync.model.transform.OptionsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}