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)	The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
CreateTaskRequest.Builder	destinationLocationArn(String destinationLocationArn)	The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
CreateTaskRequest.Builder	excludes(Collection<FilterRule> excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
CreateTaskRequest.Builder	excludes(Consumer<FilterRule.Builder>... excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
CreateTaskRequest.Builder	excludes(FilterRule... excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
CreateTaskRequest.Builder	includes(Collection<FilterRule> includes)	Specifies a list of filter rules that include specific data during your transfer.
CreateTaskRequest.Builder	includes(Consumer<FilterRule.Builder>... includes)	Specifies a list of filter rules that include specific data during your transfer.
CreateTaskRequest.Builder	includes(FilterRule... includes)	Specifies a list of filter rules that include specific data during your transfer.
CreateTaskRequest.Builder	name(String name)	The name of a task.
default CreateTaskRequest.Builder	options(Consumer<Options.Builder> options)	Specifies the configuration options for a task.
CreateTaskRequest.Builder	options(Options options)	Specifies the configuration options for a task.
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 used to periodically transfer files from a source to a destination location.
CreateTaskRequest.Builder	schedule(TaskSchedule schedule)	Specifies a schedule used to periodically transfer files from a source to a destination location.
CreateTaskRequest.Builder	sourceLocationArn(String sourceLocationArn)	The Amazon Resource Name (ARN) of the source location for the task.
CreateTaskRequest.Builder	tags(Collection<TagListEntry> tags)	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
CreateTaskRequest.Builder	tags(Consumer<TagListEntry.Builder>... tags)	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
CreateTaskRequest.Builder	tags(TagListEntry... tags)	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
default CreateTaskRequest.Builder	taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.
CreateTaskRequest.Builder	taskReportConfig(TaskReportConfig taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about for 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)

The Amazon Resource Name (ARN) of the source location for the task.

Parameters:

sourceLocationArn - The Amazon Resource Name (ARN) of the source location for the task.

Returns:

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

destinationLocationArn

CreateTaskRequest.Builder destinationLocationArn(String destinationLocationArn)

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Parameters:

destinationLocationArn - The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Returns:

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

cloudWatchLogGroupArn

CreateTaskRequest.Builder cloudWatchLogGroupArn(String cloudWatchLogGroupArn)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Parameters:

cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Returns:

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

name

CreateTaskRequest.Builder name(String name)

The name of a task. This value is a text reference that is used to identify the task in the console.

Parameters:

name - The name of a task. This value is a text reference that is used to identify the task in the console.

Returns:

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

options

CreateTaskRequest.Builder options(Options options)

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

Parameters:

options - Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

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 the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

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 a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Parameters:

excludes - Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Returns:

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

excludes

CreateTaskRequest.Builder excludes(FilterRule... excludes)

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Parameters:

excludes - Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Returns:

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

excludes

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

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

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 used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Parameters:

schedule - Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. 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 used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. 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 the Amazon Resource Name (ARN) representing the 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 the Amazon Resource Name (ARN) representing the 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 the Amazon Resource Name (ARN) representing the 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 the Amazon Resource Name (ARN) representing the 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 the Amazon Resource Name (ARN) representing the 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 a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Parameters:

includes - Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Returns:

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

includes

CreateTaskRequest.Builder includes(FilterRule... includes)

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Parameters:

includes - Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Returns:

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

includes

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

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

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

taskReportConfig

CreateTaskRequest.Builder taskReportConfig(TaskReportConfig taskReportConfig)

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

Parameters:

taskReportConfig - Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

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 for your DataSync transfer.

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.