fsx/aws.sdk.kotlin.services.fsx.model/DataRepositoryTask

DataRepositoryTask

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

Types

Builder

class Builder

Companion

object Companion

Properties

capacityToRelease

val capacityToRelease: Long?

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.

creationTime

val creationTime: Instant?

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

endTime

val endTime: Instant?

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

failureDetails

val failureDetails: DataRepositoryTaskFailureDetails?

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

fileCacheId

val fileCacheId: String?

The system-generated, unique ID of the cache.

fileSystemId

val fileSystemId: String?

The globally unique ID of the file system.

lifecycle

val lifecycle: DataRepositoryTaskLifecycle?

The lifecycle status of the data repository task, as follows:

paths

val paths: List<String>?

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.

releaseConfiguration

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

report

val report: CompletionReport?

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

resourceArn

val resourceArn: String?

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

startTime

val startTime: Instant?

The time the system began processing the task.

status

val status: DataRepositoryTaskStatus?

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

Functions

copy

inline fun copy(block: DataRepositoryTask.Builder.() -> Unit = {}): DataRepositoryTask

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String