java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.datasync.model.DataSyncRequest
    - - software.amazon.awssdk.services.datasync.model.CreateTaskRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateTaskRequest
extends DataSyncRequest
implements ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

CreateTaskRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateTaskRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateTaskRequest.Builder`	`builder()`
`String`	`cloudWatchLogGroupArn()`	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
`String`	`destinationLocationArn()`	Specifies the ARN of your transfer's destination location.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FilterRule>`	`excludes()`	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExcludes()`	For responses, this returns true if the service returned a value for the Excludes property.
`int`	`hashCode()`
`boolean`	`hasIncludes()`	For responses, this returns true if the service returned a value for the Includes property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<FilterRule>`	`includes()`	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
`ManifestConfig`	`manifestConfig()`	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
`String`	`name()`	Specifies the name of your task.
`Options`	`options()`	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
`TaskSchedule`	`schedule()`	Specifies a schedule for when you want your task to run.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateTaskRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceLocationArn()`	Specifies the ARN of your transfer's source location.
`List<TagListEntry>`	`tags()`	Specifies the tags that you want to apply to your task.
`TaskMode`	`taskMode()`	Specifies one of the following task modes for your data transfer:
`String`	`taskModeAsString()`	Specifies one of the following task modes for your data transfer:
`TaskReportConfig`	`taskReportConfig()`	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
`CreateTaskRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - sourceLocationArn
```
public final String sourceLocationArn()
```
    Specifies the ARN of your transfer's source location.
    
    Returns:
    
    Specifies the ARN of your transfer's source location.
  - destinationLocationArn
```
public final String destinationLocationArn()
```
    Specifies the ARN of your transfer's destination location.
    
    Returns:
    
    Specifies the ARN of your transfer's destination location.
  - cloudWatchLogGroupArn
```
public final String cloudWatchLogGroupArn()
```
    Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
    
    For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync.
    
    Returns:
    
    Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
    
    For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync.
  - name
```
public final String name()
```
    Specifies the name of your task.
    
    Returns:
    
    Specifies the name of your task.
  - options
```
public final Options options()
```
    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
    
    Returns:
    
    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
  - hasExcludes
```
public final boolean hasExcludes()
```
    For responses, this returns true if the service returned a value for the Excludes 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.
  - excludes
```
public final List<FilterRule> excludes()
```
    Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
    
    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 hasExcludes() method.
    
    Returns:
    
    Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
  - schedule
```
public final TaskSchedule schedule()
```
    Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
    
    Returns:
    
    Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
  - 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<TagListEntry> tags()
```
    Specifies the tags that you want to apply to your task.
    
    Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
    
    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:
    
    Specifies the tags that you want to apply to your task.
    
    Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
  - hasIncludes
```
public final boolean hasIncludes()
```
    For responses, this returns true if the service returned a value for the Includes 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.
  - includes
```
public final List<FilterRule> includes()
```
    Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
    
    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 hasIncludes() method.
    
    Returns:
    
    Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
  - manifestConfig
```
public final ManifestConfig manifestConfig()
```
    Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
    
    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
    
    Returns:
    
    Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
    
    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
  - taskReportConfig
```
public final TaskReportConfig taskReportConfig()
```
    Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
    
    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
    
    Returns:
    
    Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
    
    When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
  - taskMode
```
public final TaskMode taskMode()
```
    Specifies one of the following task modes for your data transfer:
    
    ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.
    
    To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.
    
    BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.
    
    For more information, see Understanding task mode differences.
    
    If the service returns an enum value that is not available in the current SDK version, taskMode will return TaskMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskModeAsString().
    Returns:
    
    Specifies one of the following task modes for your data transfer:
    
    ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.
    
    To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.
    
    BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.
    
    For more information, see Understanding task mode differences.
    
    See Also:
    
    TaskMode
  - taskModeAsString
```
public final String taskModeAsString()
```
    Specifies one of the following task modes for your data transfer:
    
    ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.
    
    To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.
    
    BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.
    
    For more information, see Understanding task mode differences.
    
    If the service returns an enum value that is not available in the current SDK version, taskMode will return TaskMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskModeAsString().
    Returns:
    
    Specifies one of the following task modes for your data transfer:
    
    ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.
    
    To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.
    
    BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.
    
    For more information, see Understanding task mode differences.
    
    See Also:
    
    TaskMode
  - toBuilder
```
public CreateTaskRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>
    
    Specified by:
    
    toBuilder in class DataSyncRequest
  - builder
```
public static CreateTaskRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateTaskRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateTaskRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

sourceLocationArn

destinationLocationArn

cloudWatchLogGroupArn

name

options

hasExcludes

excludes

schedule

hasTags

tags

hasIncludes

includes

manifestConfig

taskReportConfig

taskMode

taskModeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField