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 and 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) A list of filter rules that determines which files to exclude from a task.
CreateTaskRequest.Builder	excludes(Consumer<FilterRule.Builder>... excludes) A list of filter rules that determines which files to exclude from a task.
CreateTaskRequest.Builder	excludes(FilterRule... excludes) A list of filter rules that determines which files to exclude from a task.
CreateTaskRequest.Builder	includes(Collection<FilterRule> includes) A list of filter rules that determines which files to include when running a task.
CreateTaskRequest.Builder	includes(Consumer<FilterRule.Builder>... includes) A list of filter rules that determines which files to include when running a task.
CreateTaskRequest.Builder	includes(FilterRule... includes) A list of filter rules that determines which files to include when running a task.
CreateTaskRequest.Builder	name(String name) The name of a task.
default CreateTaskRequest.Builder	options(Consumer<Options.Builder> options) The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
CreateTaskRequest.Builder	options(Options options) The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
CreateTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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) The key-value pair that represents the tag that you want to add to the resource.
CreateTaskRequest.Builder	tags(Consumer<TagListEntry.Builder>... tags) The key-value pair that represents the tag that you want to add to the resource.
CreateTaskRequest.Builder	tags(TagListEntry... tags) The key-value pair that represents the tag that you want to add to the resource.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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)

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Parameters:

options - The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Returns:

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

options

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

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

This is a convenience 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)

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Parameters:

excludes - A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Returns:

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

excludes

CreateTaskRequest.Builder excludes(FilterRule... excludes)

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Parameters:

excludes - A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Returns:

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

excludes

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

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #excludes(List).

Parameters:

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

Returns:

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

See Also:

#excludes(List)

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

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Returns:

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

tags

CreateTaskRequest.Builder tags(TagListEntry... tags)

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Returns:

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

tags

CreateTaskRequest.Builder tags(Consumer<TagListEntry.Builder>... tags)

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

includes

CreateTaskRequest.Builder includes(Collection<FilterRule> includes)

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Parameters:

includes - A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Returns:

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

includes

CreateTaskRequest.Builder includes(FilterRule... includes)

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Parameters:

includes - A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Returns:

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

includes

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

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #includes(List).

Parameters:

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

Returns:

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

See Also:

#includes(List)

overrideConfiguration

CreateTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder