com.amazonaws.services.fsx.model

Class CreateDataRepositoryTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fsx.model.CreateDataRepositoryTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDataRepositoryTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDataRepositoryTaskRequest()

Method Summary

Modifier and Type	Method and Description
CreateDataRepositoryTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getCapacityToRelease() 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	getClientRequestToken()
String	getFileSystemId()
List<String>	getPaths() A list of paths for the data repository task to use when the task is processed.
CompletionReport	getReport() Defines whether or not Amazon FSx provides a CompletionReport once the task has completed.
List<Tag>	getTags()
String	getType() Specifies the type of data repository task to create.
int	hashCode()
void	setCapacityToRelease(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.
void	setClientRequestToken(String clientRequestToken)
void	setFileSystemId(String fileSystemId)
void	setPaths(Collection<String> paths) A list of paths for the data repository task to use when the task is processed.
void	setReport(CompletionReport report) Defines whether or not Amazon FSx provides a CompletionReport once the task has completed.
void	setTags(Collection<Tag> tags)
void	setType(String type) Specifies the type of data repository task to create.
String	toString() Returns a string representation of this object.
CreateDataRepositoryTaskRequest	withCapacityToRelease(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.
CreateDataRepositoryTaskRequest	withClientRequestToken(String clientRequestToken)
CreateDataRepositoryTaskRequest	withFileSystemId(String fileSystemId)
CreateDataRepositoryTaskRequest	withPaths(Collection<String> paths) A list of paths for the data repository task to use when the task is processed.
CreateDataRepositoryTaskRequest	withPaths(String... paths) A list of paths for the data repository task to use when the task is processed.
CreateDataRepositoryTaskRequest	withReport(CompletionReport report) Defines whether or not Amazon FSx provides a CompletionReport once the task has completed.
CreateDataRepositoryTaskRequest	withTags(Collection<Tag> tags)
CreateDataRepositoryTaskRequest	withTags(Tag... tags) NOTE: This method appends the values to the existing list (if any).
CreateDataRepositoryTaskRequest	withType(DataRepositoryTaskType type) Specifies the type of data repository task to create.
CreateDataRepositoryTaskRequest	withType(String type) Specifies the type of data repository task to create.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDataRepositoryTaskRequest

public CreateDataRepositoryTaskRequest()

Method Detail

setType

public void setType(String type)

Specifies the type of data repository task to create.

Parameters:

type - Specifies the type of data repository task to create.

See Also:

DataRepositoryTaskType

getType

public String getType()

Specifies the type of data repository task to create.

Returns:

Specifies the type of data repository task to create.

See Also:

DataRepositoryTaskType

withType

public CreateDataRepositoryTaskRequest withType(String type)

Specifies the type of data repository task to create.

Parameters:

type - Specifies the type of data repository task to create.

Returns:

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

See Also:

DataRepositoryTaskType

withType

public CreateDataRepositoryTaskRequest withType(DataRepositoryTaskType type)

Specifies the type of data repository task to create.

Parameters:

type - Specifies the type of data repository task to create.

Returns:

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

See Also:

DataRepositoryTaskType

getPaths

public List<String> getPaths()

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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

setPaths

public void setPaths(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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

withPaths

public CreateDataRepositoryTaskRequest withPaths(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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

NOTE: This method appends the values to the existing list (if any). Use setPaths(java.util.Collection) or withPaths(java.util.Collection) if you want to override the existing values.

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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

Returns:

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

withPaths

public CreateDataRepositoryTaskRequest withPaths(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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

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.

• For export tasks, the list contains paths on the Amazon FSx 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 Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

Returns:

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

setFileSystemId

public void setFileSystemId(String fileSystemId)

Parameters:

fileSystemId -

getFileSystemId

public String getFileSystemId()

Returns:

withFileSystemId

public CreateDataRepositoryTaskRequest withFileSystemId(String fileSystemId)

Parameters:

fileSystemId -

Returns:

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

setReport

public void setReport(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.

getReport

public CompletionReport getReport()

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.

withReport

public CreateDataRepositoryTaskRequest withReport(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.

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

Parameters:

clientRequestToken -

getClientRequestToken

public String getClientRequestToken()

Returns:

withClientRequestToken

public CreateDataRepositoryTaskRequest withClientRequestToken(String clientRequestToken)

Parameters:

clientRequestToken -

Returns:

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

getTags

public List<Tag> getTags()

Returns:

setTags

public void setTags(Collection<Tag> tags)

Parameters:

tags -

withTags

public CreateDataRepositoryTaskRequest withTags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

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

withTags

public CreateDataRepositoryTaskRequest withTags(Collection<Tag> tags)

Parameters:

tags -

Returns:

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

setCapacityToRelease

public void setCapacityToRelease(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.

getCapacityToRelease

public Long getCapacityToRelease()

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.

withCapacityToRelease

public CreateDataRepositoryTaskRequest withCapacityToRelease(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDataRepositoryTaskRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()