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()
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() Returns true if the Paths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	paths() (Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed.
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.

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.

See Also:

DataRepositoryTaskType

typeAsString

public final String typeAsString()

Specifies the type of data repository task to create.

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.

See Also:

DataRepositoryTaskType

hasPaths

public final boolean hasPaths()

Returns true if the Paths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

paths

public final List<String> paths()

(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. 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. If a path that you provide isn't valid, the task fails.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPaths() to see if a value was sent in this field.

Returns:

(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. 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. If a path that you provide isn't valid, the task fails.

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

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

Returns:

The value of the Tags property for this object.

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