DataRepositoryTask (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.fsx.model.DataRepositoryTask

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DataRepositoryTask
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DataRepositoryTask.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DataRepositoryTask.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DataRepositoryTask.Builder`	`builder()`
`Instant`	`creationTime()` Returns the value of the CreationTime property for this object.
`Instant`	`endTime()` The time that Amazon FSx completed processing the task, populated after the task is complete.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`DataRepositoryTaskFailureDetails`	`failureDetails()` Failure message describing why the task failed, it is populated only when `Lifecycle` is set to `FAILED`.
`String`	`fileSystemId()` Returns the value of the FileSystemId property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPaths()` Returns true if the Paths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`DataRepositoryTaskLifecycle`	`lifecycle()` The lifecycle status of the data repository task, as follows:
`String`	`lifecycleAsString()` The lifecycle status of the data repository task, as follows:
`List<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.
`CompletionReport`	`report()` Returns the value of the Report property for this object.
`String`	`resourceARN()` Returns the value of the ResourceARN property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DataRepositoryTask.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The time that Amazon FSx began processing the task.
`DataRepositoryTaskStatus`	`status()` Provides the status of the number of files that the task has processed successfully and failed to process.
`List<Tag>`	`tags()` Returns the value of the Tags property for this object.
`String`	`taskId()` The system-generated, unique 17-digit ID of the data repository task.
`DataRepositoryTask.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DataRepositoryTaskType`	`type()` The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
`String`	`typeAsString()` The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - taskId
```
public final String taskId()
```
    The system-generated, unique 17-digit ID of the data repository task.
    
    Returns:
    
    The system-generated, unique 17-digit ID of the data repository task.
  - lifecycle
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, lifecycle will return DataRepositoryTaskLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    Returns:
    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.
    See Also:
    
    DataRepositoryTaskLifecycle
  - lifecycleAsString
```
public final String lifecycleAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, lifecycle will return DataRepositoryTaskLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    Returns:
    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.
    See Also:
    
    DataRepositoryTaskLifecycle
  - type
```
public final DataRepositoryTaskType type()
```
    The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DataRepositoryTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
    
    See Also:
    
    DataRepositoryTaskType
  - typeAsString
```
public final String typeAsString()
```
    The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DataRepositoryTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
    
    See Also:
    
    DataRepositoryTaskType
  - creationTime
```
public final Instant creationTime()
```
    Returns the value of the CreationTime property for this object.
    
    Returns:
    
    The value of the CreationTime property for this object.
  - startTime
```
public final Instant startTime()
```
    The time that Amazon FSx began processing the task.
    
    Returns:
    
    The time that Amazon FSx began processing the task.
  - endTime
```
public final Instant endTime()
```
    The time that Amazon FSx completed processing the task, populated after the task is complete.
    
    Returns:
    
    The time that Amazon FSx completed processing the task, populated after the task is complete.
  - resourceARN
```
public final String resourceARN()
```
    Returns the value of the ResourceARN property for this object.
    
    Returns:
    
    The value of the ResourceARN property for this object.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    Returns the value of the Tags property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The value of the Tags property for this object.
  - fileSystemId
```
public final String fileSystemId()
```
    Returns the value of the FileSystemId property for this object.
    
    Returns:
    
    The value of the FileSystemId property for this object.
  - hasPaths
```
public final boolean hasPaths()
```
    Returns true if the Paths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - paths
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPaths() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - failureDetails
```
public final DataRepositoryTaskFailureDetails failureDetails()
```
    Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.
    
    Returns:
    
    Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.
  - status
```
public final DataRepositoryTaskStatus status()
```
    Provides the status of the number of files that the task has processed successfully and failed to process.
    
    Returns:
    
    Provides the status of the number of files that the task has processed successfully and failed to process.
  - report
```
public final CompletionReport report()
```
    Returns the value of the Report property for this object.
    
    Returns:
    
    The value of the Report property for this object.
  - toBuilder
```
public DataRepositoryTask.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>
  - builder
```
public static DataRepositoryTask.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DataRepositoryTask.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DataRepositoryTask

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

taskId

lifecycle

lifecycleAsString

type

typeAsString

creationTime

startTime

endTime

resourceARN

hasTags

tags

fileSystemId

hasPaths

paths

failureDetails

status

report

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields