Class CreateDataRepositoryTaskRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDataRepositoryTaskRequest.Builder,
CreateDataRepositoryTaskRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Long
Specifies the amount of data to release, in GiB, by an Amazon File CacheAUTO_RELEASE_DATA
task that automatically releases files from the cache.final String
Returns the value of the ClientRequestToken property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Returns the value of the FileSystemId property for this object.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasPaths()
For responses, this returns true if the service returned a value for the Paths property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.paths()
A list of paths for the data repository task to use when the task is processed.final ReleaseConfiguration
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.final CompletionReport
report()
Defines whether or not Amazon FSx provides a CompletionReport once the task has completed.static Class
<? extends CreateDataRepositoryTaskRequest.Builder> tags()
Returns the value of the Tags property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DataRepositoryTaskType
type()
Specifies the type of data repository task to create.final String
Specifies the type of data repository task to create.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnDataRepositoryTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
typeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnDataRepositoryTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
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 theisEmpty()
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
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 ispath1
. -
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
(wheremyPrefix
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.
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:
- 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 ispath1
. -
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
(wheremyPrefix
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.
-
-
-
fileSystemId
Returns the value of the FileSystemId property for this object.- Returns:
- The value of the FileSystemId property for this object.
-
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:
- 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.
-
clientRequestToken
Returns the value of the ClientRequestToken property for this object.- Returns:
- The value of the ClientRequestToken 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 theisEmpty()
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
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.
-
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.
-
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
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 interfaceToCopyableBuilder<CreateDataRepositoryTaskRequest.Builder,
CreateDataRepositoryTaskRequest> - Specified by:
toBuilder
in classFSxRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-