Package software.amazon.awssdk.services.datasync.model

Interface CreateTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>, DataSyncRequest.Builder, SdkBuilder<CreateTaskRequest.Builder,CreateTaskRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateTaskRequest

public static interface CreateTaskRequest.Builder
extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

Method Summary

Modifier and Type	Method	Description
CreateTaskRequest.Builder	cloudWatchLogGroupArn(String cloudWatchLogGroupArn)	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
CreateTaskRequest.Builder	destinationLocationArn(String destinationLocationArn)	Specifies the ARN of your transfer's destination location.
CreateTaskRequest.Builder	excludes(Collection<FilterRule> excludes)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
CreateTaskRequest.Builder	excludes(Consumer<FilterRule.Builder>... excludes)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
CreateTaskRequest.Builder	excludes(FilterRule... excludes)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
CreateTaskRequest.Builder	includes(Collection<FilterRule> includes)	Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
CreateTaskRequest.Builder	includes(Consumer<FilterRule.Builder>... includes)	Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
CreateTaskRequest.Builder	includes(FilterRule... includes)	Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
default CreateTaskRequest.Builder	manifestConfig(Consumer<ManifestConfig.Builder> manifestConfig)	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
CreateTaskRequest.Builder	manifestConfig(ManifestConfig manifestConfig)	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
CreateTaskRequest.Builder	name(String name)	Specifies the name of your task.
default CreateTaskRequest.Builder	options(Consumer<Options.Builder> options)	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
CreateTaskRequest.Builder	options(Options options)	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
CreateTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateTaskRequest.Builder	schedule(Consumer<TaskSchedule.Builder> schedule)	Specifies a schedule for when you want your task to run.
CreateTaskRequest.Builder	schedule(TaskSchedule schedule)	Specifies a schedule for when you want your task to run.
CreateTaskRequest.Builder	sourceLocationArn(String sourceLocationArn)	Specifies the ARN of your transfer's source location.
CreateTaskRequest.Builder	tags(Collection<TagListEntry> tags)	Specifies the tags that you want to apply to your task.
CreateTaskRequest.Builder	tags(Consumer<TagListEntry.Builder>... tags)	Specifies the tags that you want to apply to your task.
CreateTaskRequest.Builder	tags(TagListEntry... tags)	Specifies the tags that you want to apply to your task.
default CreateTaskRequest.Builder	taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
CreateTaskRequest.Builder	taskReportConfig(TaskReportConfig taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

sourceLocationArn

CreateTaskRequest.Builder sourceLocationArn(String sourceLocationArn)

Specifies the ARN of your transfer's source location.

Parameters:

sourceLocationArn - Specifies the ARN of your transfer's source location.

Returns:

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

destinationLocationArn

CreateTaskRequest.Builder destinationLocationArn(String destinationLocationArn)

Specifies the ARN of your transfer's destination location.

Parameters:

destinationLocationArn - Specifies the ARN of your transfer's destination location.

Returns:

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

cloudWatchLogGroupArn

CreateTaskRequest.Builder cloudWatchLogGroupArn(String cloudWatchLogGroupArn)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Parameters:

cloudWatchLogGroupArn - Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Returns:

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

name

CreateTaskRequest.Builder name(String name)

Specifies the name of your task.

Parameters:

name - Specifies the name of your task.

Returns:

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

options

CreateTaskRequest.Builder options(Options options)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

Parameters:

options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

Returns:

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

options

default CreateTaskRequest.Builder options(Consumer<Options.Builder> options)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

This is a convenience method that creates an instance of the Options.Builder avoiding the need to create one manually via Options.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to options(Options).

Parameters:

options - a consumer that will call methods on Options.Builder

Returns:

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

See Also:

• options(Options)

excludes

CreateTaskRequest.Builder excludes(Collection<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.

Parameters:

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.

Returns:

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

excludes

CreateTaskRequest.Builder excludes(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.

Parameters:

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.

Returns:

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

excludes

CreateTaskRequest.Builder excludes(Consumer<FilterRule.Builder>... 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.

This is a convenience method that creates an instance of the FilterRule.Builder avoiding the need to create one manually via FilterRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to excludes(List<FilterRule>).

Parameters:

excludes - a consumer that will call methods on FilterRule.Builder

Returns:

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

See Also:

• excludes(java.util.Collection<FilterRule>)

schedule

CreateTaskRequest.Builder schedule(TaskSchedule schedule)

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Parameters:

schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Returns:

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

schedule

default CreateTaskRequest.Builder schedule(Consumer<TaskSchedule.Builder> schedule)

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

This is a convenience method that creates an instance of the TaskSchedule.Builder avoiding the need to create one manually via TaskSchedule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(TaskSchedule).

Parameters:

schedule - a consumer that will call methods on TaskSchedule.Builder

Returns:

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

See Also:

• schedule(TaskSchedule)

tags

CreateTaskRequest.Builder tags(Collection<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.

Parameters:

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.

Returns:

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

tags

CreateTaskRequest.Builder tags(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.

Parameters:

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.

Returns:

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

tags

CreateTaskRequest.Builder tags(Consumer<TagListEntry.Builder>... 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.

This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

Parameters:

tags - a consumer that will call methods on TagListEntry.Builder

Returns:

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

See Also:

• tags(java.util.Collection<TagListEntry>)

includes

CreateTaskRequest.Builder includes(Collection<FilterRule> includes)

Specifies include filters 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.

Parameters:

includes - Specifies include filters 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.

Returns:

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

includes

CreateTaskRequest.Builder includes(FilterRule... includes)

Specifies include filters 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.

Parameters:

includes - Specifies include filters 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.

Returns:

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

includes

CreateTaskRequest.Builder includes(Consumer<FilterRule.Builder>... includes)

Specifies include filters 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.

This is a convenience method that creates an instance of the FilterRule.Builder avoiding the need to create one manually via FilterRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to includes(List<FilterRule>).

Parameters:

includes - a consumer that will call methods on FilterRule.Builder

Returns:

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

See Also:

• includes(java.util.Collection<FilterRule>)

manifestConfig

CreateTaskRequest.Builder manifestConfig(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.

Parameters:

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:

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

manifestConfig

default CreateTaskRequest.Builder manifestConfig(Consumer<ManifestConfig.Builder> 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.

This is a convenience method that creates an instance of the ManifestConfig.Builder avoiding the need to create one manually via ManifestConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to manifestConfig(ManifestConfig).

Parameters:

manifestConfig - a consumer that will call methods on ManifestConfig.Builder

Returns:

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

See Also:

• manifestConfig(ManifestConfig)

taskReportConfig

CreateTaskRequest.Builder taskReportConfig(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.

Parameters:

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:

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

taskReportConfig

default CreateTaskRequest.Builder taskReportConfig(Consumer<TaskReportConfig.Builder> 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.

This is a convenience method that creates an instance of the TaskReportConfig.Builder avoiding the need to create one manually via TaskReportConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskReportConfig(TaskReportConfig).

Parameters:

taskReportConfig - a consumer that will call methods on TaskReportConfig.Builder

Returns:

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

See Also:

• taskReportConfig(TaskReportConfig)

overrideConfiguration

CreateTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.