Class DataRepositoryTask

java.lang.Object
software.amazon.awssdk.services.fsx.model.DataRepositoryTask
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>
@Generated("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 import and export data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository.

  • You use release data repository tasks to release files that have been exported to a linked S3 bucket from your Amazon FSx for Lustre file system.

  • An Amazon File Cache resource uses a task to automatically release files from the cache.

To learn more about data repository tasks, see Data Repository Tasks.

See Also:

  • Method Details

    • 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 - 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.

      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 - 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.

      See Also:

    • lifecycleAsString

      public final String lifecycleAsString()

      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.

      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 - 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.

      See Also:

    • type

      public final 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.

      • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

      • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

      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 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.

      • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

      • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

      See Also:

    • typeAsString

      public final String typeAsString()

      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.

      • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

      • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

      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 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.

      • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

      • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

      See Also:

    • 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 the system began processing the task.

      Returns:
      The time the system began processing the task.

    • endTime

      public final Instant endTime()

      The time the system completed processing the task, populated after the task is complete.

      Returns:
      The time the system 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()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • fileSystemId

      public final String fileSystemId()

      The globally unique ID of the file system.

      Returns:
      The globally unique ID of the file system.

    • hasPaths

      public final boolean hasPaths()
      For responses, this returns true if the service returned a value for the Paths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • paths

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPaths() method.

      Returns:
      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.

    • 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.

    • capacityToRelease

      public final 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.

      Returns:
      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.

    • fileCacheId

      public final String fileCacheId()

      The system-generated, unique ID of the cache.

      Returns:
      The system-generated, unique ID of the cache.

    • releaseConfiguration

      public final ReleaseConfiguration releaseConfiguration()

      The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

      Returns:
      The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

    • toBuilder

      public DataRepositoryTask.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.