/* * Copyright 2018-2023 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.fsx.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* A description of the data repository task. You use data repository tasks to perform bulk transfer operations between * an Amazon FSx for Lustre file system and a linked data repository. An Amazon File Cache resource uses a task to * automatically release files from the cache. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DataRepositoryTask implements Serializable, Cloneable, StructuredPojo { /** ** The system-generated, unique 17-digit ID of the data repository task. *
*/ private String taskId; /** ** The lifecycle status of the data repository task, as follows: *
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task failed to
* process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
* PENDING
or EXECUTING
states. Please retry when the data repository task is finished
* (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can use the
* DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
* file system immediately.
*
* The type of data repository task. *
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data
* repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon
* FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* The time the system began processing the task. *
*/ private java.util.Date startTime; /** ** The time the system completed processing the task, populated after the task is complete. *
*/ private java.util.Date endTime; private String resourceARN; private java.util.List* The globally unique ID of the file system. *
*/ private String fileSystemId; /** ** An array of paths that specify the data for the data repository task to process. For example, in an * EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository. *
*
* (Default) If Paths
is not specified, Amazon FSx uses the file system root directory.
*
* Failure message describing why the task failed, it is populated only when Lifecycle
is set to
* FAILED
.
*
* Provides the status of the number of files that the task has processed successfully and failed to process. *
*/ private DataRepositoryTaskStatus status; private CompletionReport report; /** ** Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that * automatically releases files from the cache. *
*/ private Long capacityToRelease; /** ** The system-generated, unique ID of the cache. *
*/ private String fileCacheId; /** ** The system-generated, unique 17-digit ID of the data repository task. *
* * @param taskId * The system-generated, unique 17-digit ID of the data repository task. */ public void setTaskId(String taskId) { this.taskId = taskId; } /** ** The system-generated, unique 17-digit ID of the data repository task. *
* * @return The system-generated, unique 17-digit ID of the data repository task. */ public String getTaskId() { return this.taskId; } /** ** The system-generated, unique 17-digit ID of the data repository task. *
* * @param taskId * The system-generated, unique 17-digit ID of the data repository task. * @return Returns a reference to this object so that method calls can be chained together. */ public DataRepositoryTask withTaskId(String taskId) { setTaskId(taskId); return this; } /** ** The lifecycle status of the data repository task, as follows: *
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task failed to
* process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
* PENDING
or EXECUTING
states. Please retry when the data repository task is finished
* (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can use the
* DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
* file system immediately.
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task
* failed to process. The DataRepositoryTaskFailureDetails property provides more information about
* task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in
* the PENDING
or EXECUTING
states. Please retry when the data repository task is
* finished (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can
* use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to
* delete your file system immediately.
*
* The lifecycle status of the data repository task, as follows: *
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task failed to
* process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
* PENDING
or EXECUTING
states. Please retry when the data repository task is finished
* (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can use the
* DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
* file system immediately.
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task
* failed to process. The DataRepositoryTaskFailureDetails property provides more information about
* task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in
* the PENDING
or EXECUTING
states. Please retry when the data repository task is
* finished (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You
* can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you
* need to delete your file system immediately.
*
* The lifecycle status of the data repository task, as follows: *
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task failed to
* process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
* PENDING
or EXECUTING
states. Please retry when the data repository task is finished
* (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can use the
* DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
* file system immediately.
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task
* failed to process. The DataRepositoryTaskFailureDetails property provides more information about
* task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in
* the PENDING
or EXECUTING
states. Please retry when the data repository task is
* finished (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can
* use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to
* delete your file system immediately.
*
* The lifecycle status of the data repository task, as follows: *
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task failed to
* process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
* PENDING
or EXECUTING
states. Please retry when the data repository task is finished
* (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can use the
* DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
* file system immediately.
*
* PENDING
- The task has not started.
*
* EXECUTING
- The task is in process.
*
* FAILED
- The task was not able to be completed. For example, there may be files the task
* failed to process. The DataRepositoryTaskFailureDetails property provides more information about
* task failures.
*
* SUCCEEDED
- The task has completed successfully.
*
* CANCELED
- The task was canceled and it did not complete.
*
* CANCELING
- The task is in process of being canceled.
*
* You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in
* the PENDING
or EXECUTING
states. Please retry when the data repository task is
* finished (with a status of CANCELED
, SUCCEEDED
, or FAILED
). You can
* use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to
* delete your file system immediately.
*
* The type of data repository task. *
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data
* repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon
* FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked
* data repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your
* Amazon FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* The type of data repository task. *
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data
* repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon
* FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked
* data repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to
* your Amazon FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* The type of data repository task. *
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data
* repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon
* FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked
* data repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your
* Amazon FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* The type of data repository task. *
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data
* repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon
* FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked
* data repository.
*
* IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your
* Amazon FSx for Lustre file system.
*
* AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
*
* RELEASE_DATA_FROM_FILESYSTEM
tasks are not supported.
*
* The time the system began processing the task. *
* * @param startTime * The time the system began processing the task. */ public void setStartTime(java.util.Date startTime) { this.startTime = startTime; } /** ** The time the system began processing the task. *
* * @return The time the system began processing the task. */ public java.util.Date getStartTime() { return this.startTime; } /** ** The time the system began processing the task. *
* * @param startTime * The time the system began processing the task. * @return Returns a reference to this object so that method calls can be chained together. */ public DataRepositoryTask withStartTime(java.util.Date startTime) { setStartTime(startTime); return this; } /** ** The time the system completed processing the task, populated after the task is complete. *
* * @param endTime * The time the system completed processing the task, populated after the task is complete. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The time the system completed processing the task, populated after the task is complete. *
* * @return The time the system completed processing the task, populated after the task is complete. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The time the system completed processing the task, populated after the task is complete. *
* * @param endTime * The time the system completed processing the task, populated after the task is complete. * @return Returns a reference to this object so that method calls can be chained together. */ public DataRepositoryTask withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** * @param resourceARN */ public void setResourceARN(String resourceARN) { this.resourceARN = resourceARN; } /** * @return */ public String getResourceARN() { return this.resourceARN; } /** * @param resourceARN * @return Returns a reference to this object so that method calls can be chained together. */ public DataRepositoryTask withResourceARN(String resourceARN) { setResourceARN(resourceARN); return this; } /** * @return */ public java.util.List* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * @return Returns a reference to this object so that method calls can be chained together. */ public DataRepositoryTask withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* The globally unique ID of the file system. *
* * @param fileSystemId * The globally unique ID of the file system. */ public void setFileSystemId(String fileSystemId) { this.fileSystemId = fileSystemId; } /** ** The globally unique ID of the file system. *
* * @return The globally unique ID of the file system. */ public String getFileSystemId() { return this.fileSystemId; } /** ** The globally unique ID of the file system. *
* * @param fileSystemId * The globally unique ID of the file system. * @return Returns a reference to this object so that method calls can be chained together. */ public DataRepositoryTask withFileSystemId(String fileSystemId) { setFileSystemId(fileSystemId); return this; } /** ** An array of paths that specify the data for the data repository task to process. For example, in an * EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository. *
*
* (Default) If Paths
is not specified, Amazon FSx uses the file system root directory.
*
* (Default) If
* An array of paths that specify the data for the data repository task to process. For example, in an
* EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
*
* (Default) If Paths
is not specified, Amazon FSx uses the file system root directory.
*/
public java.util.ListPaths
is not specified, Amazon FSx uses the file system root directory.
*
* (Default) If
* An array of paths that specify the data for the data repository task to process. For example, in an
* EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
*
* (Default) If
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPaths(java.util.Collection)} or {@link #withPaths(java.util.Collection)} if you want to override the
* existing values.
* Paths
is not specified, Amazon FSx uses the file system root directory.
*/
public void setPaths(java.util.CollectionPaths
is not specified, Amazon FSx uses the file system root directory.
*
* (Default) If
* An array of paths that specify the data for the data repository task to process. For example, in an
* EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
*
* (Default) If Paths
is not specified, Amazon FSx uses the file system root directory.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataRepositoryTask withPaths(String... paths) {
if (this.paths == null) {
setPaths(new java.util.ArrayListPaths
is not specified, Amazon FSx uses the file system root directory.
*
* (Default) If
* Failure message describing why the task failed, it is populated only when
* Failure message describing why the task failed, it is populated only when
* Failure message describing why the task failed, it is populated only when
* Provides the status of the number of files that the task has processed successfully and failed to process.
*
* Provides the status of the number of files that the task has processed successfully and failed to process.
*
* Provides the status of the number of files that the task has processed successfully and failed to process.
*
* Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that
* automatically releases files from the cache.
*
* Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that
* automatically releases files from the cache.
*
* Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that
* automatically releases files from the cache.
*
* The system-generated, unique ID of the cache.
*
* The system-generated, unique ID of the cache.
*
* The system-generated, unique ID of the cache.
* Paths
is not specified, Amazon FSx uses the file system root directory.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataRepositoryTask withPaths(java.util.CollectionLifecycle
is set to
* FAILED
.
* Lifecycle
is set to
* FAILED
.
*/
public void setFailureDetails(DataRepositoryTaskFailureDetails failureDetails) {
this.failureDetails = failureDetails;
}
/**
* Lifecycle
is set to
* FAILED
.
* Lifecycle
is set
* to FAILED
.
*/
public DataRepositoryTaskFailureDetails getFailureDetails() {
return this.failureDetails;
}
/**
* Lifecycle
is set to
* FAILED
.
* Lifecycle
is set to
* FAILED
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataRepositoryTask withFailureDetails(DataRepositoryTaskFailureDetails failureDetails) {
setFailureDetails(failureDetails);
return this;
}
/**
*