software.amazon.awssdk.services.fsx.model

Class CreateDataRepositoryTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.fsx.model.FSxRequest

software.amazon.awssdk.services.fsx.model.CreateDataRepositoryTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDataRepositoryTaskRequest.Builder,CreateDataRepositoryTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDataRepositoryTaskRequest
extends FSxRequest
implements ToCopyableBuilder<CreateDataRepositoryTaskRequest.Builder,CreateDataRepositoryTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDataRepositoryTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDataRepositoryTaskRequest.Builder	builder()
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.
String	clientRequestToken() Returns the value of the ClientRequestToken property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId() Returns the value of the FileSystemId property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPaths() For responses, this returns true if the service returned a value for the Paths property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<String>	paths() A list of paths for the data repository task to use when the task is processed.
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.
CompletionReport	report() Defines whether or not Amazon FSx provides a CompletionReport once the task has completed.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDataRepositoryTaskRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Returns the value of the Tags property for this object.
CreateDataRepositoryTaskRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DataRepositoryTaskType	type() Specifies the type of data repository task to create.
String	typeAsString() Specifies the type of data repository task to create.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

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

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:

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:

DataRepositoryTaskType

typeAsString

public final String 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 return DataRepositoryTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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:

DataRepositoryTaskType

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()

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.

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

fileSystemId

public final String fileSystemId()

Returns the value of the FileSystemId property for this object.

Returns:

The value of the FileSystemId property for this object.

report

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

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

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

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.

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 CreateDataRepositoryTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDataRepositoryTaskRequest.Builder,CreateDataRepositoryTaskRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static CreateDataRepositoryTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDataRepositoryTaskRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo