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

Interface CreateDataRepositoryTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataRepositoryTaskRequest.Builder,CreateDataRepositoryTaskRequest>, FSxRequest.Builder, SdkBuilder<CreateDataRepositoryTaskRequest.Builder,CreateDataRepositoryTaskRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDataRepositoryTaskRequest
public static interface CreateDataRepositoryTaskRequest.Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder<CreateDataRepositoryTaskRequest.Builder,CreateDataRepositoryTaskRequest>

  • Method Details

    • type

      CreateDataRepositoryTaskRequest.Builder type(String type)

      Specifies the type of data repository task to create.

      • 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 - Specifies the type of data repository task to create.

      • 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

      CreateDataRepositoryTaskRequest.Builder type(DataRepositoryTaskType type)

      Specifies the type of data repository task to create.

      • 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 - Specifies the type of data repository task to create.

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

    • paths

      CreateDataRepositoryTaskRequest.Builder paths(Collection<String> paths)

      A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

      • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.

      • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

      • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

        A file must also meet the last accessed time criteria specified in for the file to be released.

      Parameters:
      paths - A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

      • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.

      • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

      • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

        A file must also meet the last accessed time criteria specified in for the file to be released.

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

    • paths

      CreateDataRepositoryTaskRequest.Builder paths(String... paths)

      A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

      • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.

      • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

      • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

        A file must also meet the last accessed time criteria specified in for the file to be released.

      Parameters:
      paths - A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

      • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.

      • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

      • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

        A file must also meet the last accessed time criteria specified in for the file to be released.

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

    • fileSystemId

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

    • report

      CreateDataRepositoryTaskRequest.Builder report(CompletionReport report)

      Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.

      Parameters:
      report - Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • report

      default CreateDataRepositoryTaskRequest.Builder report(Consumer<CompletionReport.Builder> report)

      Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.

      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:

    • clientRequestToken

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

    • tags

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

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

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

    • capacityToRelease

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

    • releaseConfiguration

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

    • overrideConfiguration

      CreateDataRepositoryTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDataRepositoryTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.