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

Interface UpdateTaskRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateTaskRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateTaskRequest.Builder	cloudWatchLogGroupArn(String cloudWatchLogGroupArn)	The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.
UpdateTaskRequest.Builder	excludes(Collection<FilterRule> excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
UpdateTaskRequest.Builder	excludes(Consumer<FilterRule.Builder>... excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
UpdateTaskRequest.Builder	excludes(FilterRule... excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
UpdateTaskRequest.Builder	includes(Collection<FilterRule> includes)	Specifies a list of filter rules that include specific data during your transfer.
UpdateTaskRequest.Builder	includes(Consumer<FilterRule.Builder>... includes)	Specifies a list of filter rules that include specific data during your transfer.
UpdateTaskRequest.Builder	includes(FilterRule... includes)	Specifies a list of filter rules that include specific data during your transfer.
default UpdateTaskRequest.Builder	manifestConfig(Consumer<ManifestConfig.Builder> manifestConfig)	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
UpdateTaskRequest.Builder	manifestConfig(ManifestConfig manifestConfig)	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
UpdateTaskRequest.Builder	name(String name)	The name of the task to update.
default UpdateTaskRequest.Builder	options(Consumer<Options.Builder> options)	Sets the value of the Options property for this object.
UpdateTaskRequest.Builder	options(Options options)	Sets the value of the Options property for this object.
UpdateTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateTaskRequest.Builder	schedule(Consumer<TaskSchedule.Builder> schedule)	Specifies a schedule used to periodically transfer files from a source to a destination location.
UpdateTaskRequest.Builder	schedule(TaskSchedule schedule)	Specifies a schedule used to periodically transfer files from a source to a destination location.
UpdateTaskRequest.Builder	taskArn(String taskArn)	The Amazon Resource Name (ARN) of the resource name of the task to update.
default UpdateTaskRequest.Builder	taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
UpdateTaskRequest.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

taskArn

UpdateTaskRequest.Builder taskArn(String taskArn)

The Amazon Resource Name (ARN) of the resource name of the task to update.

Parameters:

taskArn - The Amazon Resource Name (ARN) of the resource name of the task to update.

Returns:

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

options

UpdateTaskRequest.Builder options(Options options)

Sets the value of the Options property for this object.

Parameters:

options - The new value for the Options property for this object.

Returns:

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

options

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

Sets the value of the Options property for this object. 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

UpdateTaskRequest.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

UpdateTaskRequest.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

UpdateTaskRequest.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

UpdateTaskRequest.Builder schedule(TaskSchedule schedule)

Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is 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. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is 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 UpdateTaskRequest.Builder schedule(Consumer<TaskSchedule.Builder> schedule)

Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is 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)

name

UpdateTaskRequest.Builder name(String name)

The name of the task to update.

Parameters:

name - The name of the task to update.

Returns:

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

cloudWatchLogGroupArn

UpdateTaskRequest.Builder cloudWatchLogGroupArn(String cloudWatchLogGroupArn)

The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.

Parameters:

cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.

Returns:

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

includes

UpdateTaskRequest.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

UpdateTaskRequest.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

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

manifestConfig

UpdateTaskRequest.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 IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a manifest configuration, specify this parameter as empty.

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 IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a manifest configuration, specify this parameter as empty.

Returns:

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

manifestConfig

default UpdateTaskRequest.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 IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a manifest configuration, specify this parameter as empty.

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

UpdateTaskRequest.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 IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

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 IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

Returns:

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

taskReportConfig

default UpdateTaskRequest.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 IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

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

UpdateTaskRequest.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

UpdateTaskRequest.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.