@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DataRepositoryTask extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description | 
|---|
DataRepositoryTask()  | 
| Modifier and Type | Method and Description | 
|---|---|
DataRepositoryTask | 
clone()  | 
boolean | 
equals(Object obj)  | 
Long | 
getCapacityToRelease()
 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. 
 | 
Date | 
getCreationTime()  | 
Date | 
getEndTime()
 The time the system completed processing the task, populated after the task is complete. 
 | 
DataRepositoryTaskFailureDetails | 
getFailureDetails()
 Failure message describing why the task failed, it is populated only when  
Lifecycle is set to
 FAILED. | 
String | 
getFileCacheId()
 The system-generated, unique ID of the cache. 
 | 
String | 
getFileSystemId()
 The globally unique ID of the file system. 
 | 
String | 
getLifecycle()
 The lifecycle status of the data repository task, as follows: 
 | 
List<String> | 
getPaths()
 An array of paths that specify the data for the data repository task to process. 
 | 
CompletionReport | 
getReport()  | 
String | 
getResourceARN()  | 
Date | 
getStartTime()
 The time the system began processing the task. 
 | 
DataRepositoryTaskStatus | 
getStatus()
 Provides the status of the number of files that the task has processed successfully and failed to process. 
 | 
List<Tag> | 
getTags()  | 
String | 
getTaskId()
 The system-generated, unique 17-digit ID of the data repository task. 
 | 
String | 
getType()
 The type of data repository task. 
 | 
int | 
hashCode()  | 
void | 
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given  
ProtocolMarshaller. | 
void | 
setCapacityToRelease(Long capacityToRelease)
 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. 
 | 
void | 
setCreationTime(Date creationTime)  | 
void | 
setEndTime(Date endTime)
 The time the system completed processing the task, populated after the task is complete. 
 | 
void | 
setFailureDetails(DataRepositoryTaskFailureDetails failureDetails)
 Failure message describing why the task failed, it is populated only when  
Lifecycle is set to
 FAILED. | 
void | 
setFileCacheId(String fileCacheId)
 The system-generated, unique ID of the cache. 
 | 
void | 
setFileSystemId(String fileSystemId)
 The globally unique ID of the file system. 
 | 
void | 
setLifecycle(String lifecycle)
 The lifecycle status of the data repository task, as follows: 
 | 
void | 
setPaths(Collection<String> paths)
 An array of paths that specify the data for the data repository task to process. 
 | 
void | 
setReport(CompletionReport report)  | 
void | 
setResourceARN(String resourceARN)  | 
void | 
setStartTime(Date startTime)
 The time the system began processing the task. 
 | 
void | 
setStatus(DataRepositoryTaskStatus status)
 Provides the status of the number of files that the task has processed successfully and failed to process. 
 | 
void | 
setTags(Collection<Tag> tags)  | 
void | 
setTaskId(String taskId)
 The system-generated, unique 17-digit ID of the data repository task. 
 | 
void | 
setType(String type)
 The type of data repository task. 
 | 
String | 
toString()
Returns a string representation of this object. 
 | 
DataRepositoryTask | 
withCapacityToRelease(Long capacityToRelease)
 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. 
 | 
DataRepositoryTask | 
withCreationTime(Date creationTime)  | 
DataRepositoryTask | 
withEndTime(Date endTime)
 The time the system completed processing the task, populated after the task is complete. 
 | 
DataRepositoryTask | 
withFailureDetails(DataRepositoryTaskFailureDetails failureDetails)
 Failure message describing why the task failed, it is populated only when  
Lifecycle is set to
 FAILED. | 
DataRepositoryTask | 
withFileCacheId(String fileCacheId)
 The system-generated, unique ID of the cache. 
 | 
DataRepositoryTask | 
withFileSystemId(String fileSystemId)
 The globally unique ID of the file system. 
 | 
DataRepositoryTask | 
withLifecycle(DataRepositoryTaskLifecycle lifecycle)
 The lifecycle status of the data repository task, as follows: 
 | 
DataRepositoryTask | 
withLifecycle(String lifecycle)
 The lifecycle status of the data repository task, as follows: 
 | 
DataRepositoryTask | 
withPaths(Collection<String> paths)
 An array of paths that specify the data for the data repository task to process. 
 | 
DataRepositoryTask | 
withPaths(String... paths)
 An array of paths that specify the data for the data repository task to process. 
 | 
DataRepositoryTask | 
withReport(CompletionReport report)  | 
DataRepositoryTask | 
withResourceARN(String resourceARN)  | 
DataRepositoryTask | 
withStartTime(Date startTime)
 The time the system began processing the task. 
 | 
DataRepositoryTask | 
withStatus(DataRepositoryTaskStatus status)
 Provides the status of the number of files that the task has processed successfully and failed to process. 
 | 
DataRepositoryTask | 
withTags(Collection<Tag> tags)  | 
DataRepositoryTask | 
withTags(Tag... tags)
 NOTE: This method appends the values to the existing list (if any). 
 | 
DataRepositoryTask | 
withTaskId(String taskId)
 The system-generated, unique 17-digit ID of the data repository task. 
 | 
DataRepositoryTask | 
withType(DataRepositoryTaskType type)
 The type of data repository task. 
 | 
DataRepositoryTask | 
withType(String type)
 The type of data repository task. 
 | 
public void setTaskId(String taskId)
The system-generated, unique 17-digit ID of the data repository task.
taskId - The system-generated, unique 17-digit ID of the data repository task.public String getTaskId()
The system-generated, unique 17-digit ID of the data repository task.
public DataRepositoryTask withTaskId(String taskId)
The system-generated, unique 17-digit ID of the data repository task.
taskId - The system-generated, unique 17-digit ID of the data repository task.public void setLifecycle(String lifecycle)
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.
 
lifecycle - 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.
        
DataRepositoryTaskLifecyclepublic String getLifecycle()
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.
         
DataRepositoryTaskLifecyclepublic DataRepositoryTask withLifecycle(String lifecycle)
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.
 
lifecycle - 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.
        
DataRepositoryTaskLifecyclepublic DataRepositoryTask withLifecycle(DataRepositoryTaskLifecycle lifecycle)
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.
 
lifecycle - 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.
        
DataRepositoryTaskLifecyclepublic void setType(String type)
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.
 
type - 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.
        
DataRepositoryTaskTypepublic String getType()
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.
 
         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.
         
DataRepositoryTaskTypepublic DataRepositoryTask withType(String type)
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.
 
type - 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.
        
DataRepositoryTaskTypepublic DataRepositoryTask withType(DataRepositoryTaskType type)
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.
 
type - 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.
        
DataRepositoryTaskTypepublic void setCreationTime(Date creationTime)
creationTime - public Date getCreationTime()
public DataRepositoryTask withCreationTime(Date creationTime)
creationTime - public void setStartTime(Date startTime)
The time the system began processing the task.
startTime - The time the system began processing the task.public Date getStartTime()
The time the system began processing the task.
public DataRepositoryTask withStartTime(Date startTime)
The time the system began processing the task.
startTime - The time the system began processing the task.public void setEndTime(Date endTime)
The time the system completed processing the task, populated after the task is complete.
endTime - The time the system completed processing the task, populated after the task is complete.public Date getEndTime()
The time the system completed processing the task, populated after the task is complete.
public DataRepositoryTask withEndTime(Date endTime)
The time the system completed processing the task, populated after the task is complete.
endTime - The time the system completed processing the task, populated after the task is complete.public void setResourceARN(String resourceARN)
resourceARN - public String getResourceARN()
public DataRepositoryTask withResourceARN(String resourceARN)
resourceARN - public void setTags(Collection<Tag> tags)
tags - public DataRepositoryTask withTags(Tag... tags)
 NOTE: This method appends the values to the existing list (if any). Use
 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
 existing values.
 
tags - public DataRepositoryTask withTags(Collection<Tag> tags)
tags - public void setFileSystemId(String fileSystemId)
The globally unique ID of the file system.
fileSystemId - The globally unique ID of the file system.public String getFileSystemId()
The globally unique ID of the file system.
public DataRepositoryTask withFileSystemId(String fileSystemId)
The globally unique ID of the file system.
fileSystemId - The globally unique ID of the file system.public List<String> getPaths()
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 Paths is not specified, Amazon FSx uses the file system root directory.
public void setPaths(Collection<String> paths)
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.
 
paths - 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 DataRepositoryTask withPaths(String... paths)
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.
 
 NOTE: This method appends the values to the existing list (if any). Use
 setPaths(java.util.Collection) or withPaths(java.util.Collection) if you want to override the
 existing values.
 
paths - 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 DataRepositoryTask withPaths(Collection<String> paths)
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.
 
paths - 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 void setFailureDetails(DataRepositoryTaskFailureDetails failureDetails)
 Failure message describing why the task failed, it is populated only when Lifecycle is set to
 FAILED.
 
failureDetails - Failure message describing why the task failed, it is populated only when Lifecycle is set to
        FAILED.public DataRepositoryTaskFailureDetails getFailureDetails()
 Failure message describing why the task failed, it is populated only when Lifecycle is set to
 FAILED.
 
Lifecycle is set
         to FAILED.public DataRepositoryTask withFailureDetails(DataRepositoryTaskFailureDetails failureDetails)
 Failure message describing why the task failed, it is populated only when Lifecycle is set to
 FAILED.
 
failureDetails - Failure message describing why the task failed, it is populated only when Lifecycle is set to
        FAILED.public void setStatus(DataRepositoryTaskStatus status)
Provides the status of the number of files that the task has processed successfully and failed to process.
status - Provides the status of the number of files that the task has processed successfully and failed to process.public DataRepositoryTaskStatus getStatus()
Provides the status of the number of files that the task has processed successfully and failed to process.
public DataRepositoryTask withStatus(DataRepositoryTaskStatus status)
Provides the status of the number of files that the task has processed successfully and failed to process.
status - Provides the status of the number of files that the task has processed successfully and failed to process.public void setReport(CompletionReport report)
report - public CompletionReport getReport()
public DataRepositoryTask withReport(CompletionReport report)
report - public void setCapacityToRelease(Long capacityToRelease)
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.
capacityToRelease - 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.public Long getCapacityToRelease()
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.
public DataRepositoryTask withCapacityToRelease(Long capacityToRelease)
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.
capacityToRelease - 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.public void setFileCacheId(String fileCacheId)
The system-generated, unique ID of the cache.
fileCacheId - The system-generated, unique ID of the cache.public String getFileCacheId()
The system-generated, unique ID of the cache.
public DataRepositoryTask withFileCacheId(String fileCacheId)
The system-generated, unique ID of the cache.
fileCacheId - The system-generated, unique ID of the cache.public String toString()
toString in class ObjectObject.toString()public DataRepositoryTask clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.