Package software.amazon.awssdk.services.fsx.model

Interface DataRepositoryTask.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>, SdkBuilder<DataRepositoryTask.Builder,DataRepositoryTask>, SdkPojo
Enclosing class:
DataRepositoryTask
public static interface DataRepositoryTask.Builder extends SdkPojo, CopyableBuilder<DataRepositoryTask.Builder,DataRepositoryTask>

  • Method Details

    • taskId

      DataRepositoryTask.Builder taskId(String taskId)

      The system-generated, unique 17-digit ID of the data repository task.

      Parameters:
      taskId - The system-generated, unique 17-digit ID of the data repository task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycle

      DataRepositoryTask.Builder lifecycle(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lifecycle

      DataRepositoryTask.Builder lifecycle(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      DataRepositoryTask.Builder type(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.

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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      DataRepositoryTask.Builder type(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationTime

      DataRepositoryTask.Builder creationTime(Instant creationTime)
      Sets the value of the CreationTime property for this object.
      Parameters:
      creationTime - The new value for the CreationTime property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      DataRepositoryTask.Builder startTime(Instant startTime)

      The time the system began processing the task.

      Parameters:
      startTime - The time the system began processing the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DataRepositoryTask.Builder endTime(Instant endTime)

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

      Parameters:
      endTime - The time the system completed processing the task, populated after the task is complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceARN

      DataRepositoryTask.Builder resourceARN(String resourceARN)
      Sets the value of the ResourceARN property for this object.
      Parameters:
      resourceARN - The new value for the ResourceARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DataRepositoryTask.Builder tags(Collection<Tag> tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DataRepositoryTask.Builder tags(Tag... tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DataRepositoryTask.Builder tags(Consumer<Tag.Builder>... tags)
      Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileSystemId

      DataRepositoryTask.Builder fileSystemId(String fileSystemId)

      The globally unique ID of the file system.

      Parameters:
      fileSystemId - The globally unique ID of the file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • paths

      DataRepositoryTask.Builder paths(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • paths

      DataRepositoryTask.Builder paths(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureDetails

      DataRepositoryTask.Builder failureDetails(DataRepositoryTaskFailureDetails failureDetails)

      Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

      Parameters:
      failureDetails - Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureDetails

      default DataRepositoryTask.Builder failureDetails(Consumer<DataRepositoryTaskFailureDetails.Builder> failureDetails)

      Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

      This is a convenience method that creates an instance of the DataRepositoryTaskFailureDetails.Builder avoiding the need to create one manually via DataRepositoryTaskFailureDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDetails(DataRepositoryTaskFailureDetails).

      Parameters:
      failureDetails - a consumer that will call methods on DataRepositoryTaskFailureDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DataRepositoryTask.Builder status(DataRepositoryTaskStatus status)

      Provides the status of the number of files that the task has processed successfully and failed to process.

      Parameters:
      status - Provides the status of the number of files that the task has processed successfully and failed to process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      default DataRepositoryTask.Builder status(Consumer<DataRepositoryTaskStatus.Builder> status)

      Provides the status of the number of files that the task has processed successfully and failed to process.

      This is a convenience method that creates an instance of the DataRepositoryTaskStatus.Builder avoiding the need to create one manually via DataRepositoryTaskStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(DataRepositoryTaskStatus).

      Parameters:
      status - a consumer that will call methods on DataRepositoryTaskStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • report

      DataRepositoryTask.Builder report(CompletionReport report)
      Sets the value of the Report property for this object.
      Parameters:
      report - The new value for the Report property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • report

      default DataRepositoryTask.Builder report(Consumer<CompletionReport.Builder> report)
      Sets the value of the Report property for this object. This is a convenience method that creates an instance of the CompletionReport.Builder avoiding the need to create one manually via CompletionReport.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to report(CompletionReport).

      Parameters:
      report - a consumer that will call methods on CompletionReport.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capacityToRelease

      DataRepositoryTask.Builder capacityToRelease(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • fileCacheId

      DataRepositoryTask.Builder fileCacheId(String fileCacheId)

      The system-generated, unique ID of the cache.

      Parameters:
      fileCacheId - The system-generated, unique ID of the cache.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • releaseConfiguration

      DataRepositoryTask.Builder releaseConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • releaseConfiguration

      default DataRepositoryTask.Builder releaseConfiguration(Consumer<ReleaseConfiguration.Builder> releaseConfiguration)

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

      This is a convenience method that creates an instance of the ReleaseConfiguration.Builder avoiding the need to create one manually via ReleaseConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to releaseConfiguration(ReleaseConfiguration).

      Parameters:
      releaseConfiguration - a consumer that will call methods on ReleaseConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: