@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 your Amazon FSx file system and its linked data repository.
Constructor and Description |
---|
DataRepositoryTask() |
Modifier and Type | Method and Description |
---|---|
DataRepositoryTask |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationTime() |
Date |
getEndTime()
The time that Amazon FSx 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 |
getFileSystemId() |
String |
getLifecycle()
The lifecycle status of the data repository task, as follows:
|
List<String> |
getPaths()
An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to
process.
|
CompletionReport |
getReport() |
String |
getResourceARN() |
Date |
getStartTime()
The time that Amazon FSx 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; EXPORT_TO_REPOSITORY is the only type currently supported.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreationTime(Date creationTime) |
void |
setEndTime(Date endTime)
The time that Amazon FSx 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 |
setFileSystemId(String fileSystemId) |
void |
setLifecycle(String lifecycle)
The lifecycle status of the data repository task, as follows:
|
void |
setPaths(Collection<String> paths)
An array of paths on the Amazon FSx for Lustre file system 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 that Amazon FSx 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; EXPORT_TO_REPOSITORY is the only type currently supported.
|
String |
toString()
Returns a string representation of this object.
|
DataRepositoryTask |
withCreationTime(Date creationTime) |
DataRepositoryTask |
withEndTime(Date endTime)
The time that Amazon FSx 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 |
withFileSystemId(String fileSystemId) |
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 on the Amazon FSx for Lustre file system that specify the data for the data repository task to
process.
|
DataRepositoryTask |
withPaths(String... paths)
An array of paths on the Amazon FSx for Lustre file system 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 that Amazon FSx 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; EXPORT_TO_REPOSITORY is the only type currently supported.
|
DataRepositoryTask |
withType(String type)
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
|
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
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task
failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the
task failed to process. The DataRepositoryTaskFailureDetails property provides more information
about task failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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.
DataRepositoryTaskLifecycle
public String getLifecycle()
The lifecycle status of the data repository task, as follows:
PENDING
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task
failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the
task failed to process. The DataRepositoryTaskFailureDetails property provides more information
about task failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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.
DataRepositoryTaskLifecycle
public DataRepositoryTask withLifecycle(String lifecycle)
The lifecycle status of the data repository task, as follows:
PENDING
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task
failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the
task failed to process. The DataRepositoryTaskFailureDetails property provides more information
about task failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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.
DataRepositoryTaskLifecycle
public DataRepositoryTask withLifecycle(DataRepositoryTaskLifecycle lifecycle)
The lifecycle status of the data repository task, as follows:
PENDING
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task
failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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
- Amazon FSx has not started the task.
EXECUTING
- Amazon FSx is processing the task.
FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the
task failed to process. The DataRepositoryTaskFailureDetails property provides more information
about task failures.
SUCCEEDED
- FSx completed the task successfully.
CANCELED
- Amazon FSx canceled the task and it did not complete.
CANCELING
- FSx is in process of canceling the task.
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.
DataRepositoryTaskLifecycle
public void setType(String type)
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
type
- The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.DataRepositoryTaskType
public String getType()
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
DataRepositoryTaskType
public DataRepositoryTask withType(String type)
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
type
- The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.DataRepositoryTaskType
public DataRepositoryTask withType(DataRepositoryTaskType type)
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
type
- The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.DataRepositoryTaskType
public void setCreationTime(Date creationTime)
creationTime
- public Date getCreationTime()
public DataRepositoryTask withCreationTime(Date creationTime)
creationTime
- public void setStartTime(Date startTime)
The time that Amazon FSx began processing the task.
startTime
- The time that Amazon FSx began processing the task.public Date getStartTime()
The time that Amazon FSx began processing the task.
public DataRepositoryTask withStartTime(Date startTime)
The time that Amazon FSx began processing the task.
startTime
- The time that Amazon FSx began processing the task.public void setEndTime(Date endTime)
The time that Amazon FSx completed processing the task, populated after the task is complete.
endTime
- The time that Amazon FSx completed processing the task, populated after the task is complete.public Date getEndTime()
The time that Amazon FSx completed processing the task, populated after the task is complete.
public DataRepositoryTask withEndTime(Date endTime)
The time that Amazon FSx completed processing the task, populated after the task is complete.
endTime
- The time that Amazon FSx 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)
fileSystemId
- public String getFileSystemId()
public DataRepositoryTask withFileSystemId(String fileSystemId)
fileSystemId
- public List<String> getPaths()
An array of paths on the Amazon FSx for Lustre file system 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 on the Amazon FSx for Lustre file system 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 on the Amazon FSx for Lustre file system 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 on the Amazon FSx for Lustre file system 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 on the Amazon FSx for Lustre file system 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 on the Amazon FSx for Lustre file system 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 on the Amazon FSx for Lustre file system 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 String toString()
toString
in class Object
Object.toString()
public DataRepositoryTask clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.