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

Interface DescribeTaskResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>, DataSyncResponse.Builder, SdkBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeTaskResponse

public static interface DescribeTaskResponse.Builder
extends DataSyncResponse.Builder, SdkPojo, CopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>

Method Summary

Modifier and Type	Method	Description
DescribeTaskResponse.Builder	cloudWatchLogGroupArn(String cloudWatchLogGroupArn)	The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
DescribeTaskResponse.Builder	creationTime(Instant creationTime)	The time that the task was created.
DescribeTaskResponse.Builder	currentTaskExecutionArn(String currentTaskExecutionArn)	The Amazon Resource Name (ARN) of the task execution that is transferring files.
DescribeTaskResponse.Builder	destinationLocationArn(String destinationLocationArn)	The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
DescribeTaskResponse.Builder	destinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)	The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.
DescribeTaskResponse.Builder	destinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)	The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.
DescribeTaskResponse.Builder	errorCode(String errorCode)	Errors that DataSync encountered during execution of the task.
DescribeTaskResponse.Builder	errorDetail(String errorDetail)	Detailed description of an error that was encountered during the task execution.
DescribeTaskResponse.Builder	excludes(Collection<FilterRule> excludes)	A list of filter rules that exclude specific data during your transfer.
DescribeTaskResponse.Builder	excludes(Consumer<FilterRule.Builder>... excludes)	A list of filter rules that exclude specific data during your transfer.
DescribeTaskResponse.Builder	excludes(FilterRule... excludes)	A list of filter rules that exclude specific data during your transfer.
DescribeTaskResponse.Builder	includes(Collection<FilterRule> includes)	A list of filter rules that include specific data during your transfer.
DescribeTaskResponse.Builder	includes(Consumer<FilterRule.Builder>... includes)	A list of filter rules that include specific data during your transfer.
DescribeTaskResponse.Builder	includes(FilterRule... includes)	A list of filter rules that include specific data during your transfer.
default DescribeTaskResponse.Builder	manifestConfig(Consumer<ManifestConfig.Builder> manifestConfig)	The configuration of the manifest that lists the files or objects to transfer.
DescribeTaskResponse.Builder	manifestConfig(ManifestConfig manifestConfig)	The configuration of the manifest that lists the files or objects to transfer.
DescribeTaskResponse.Builder	name(String name)	The name of the task that was described.
default DescribeTaskResponse.Builder	options(Consumer<Options.Builder> options)	The configuration options that control the behavior of the StartTaskExecution operation.
DescribeTaskResponse.Builder	options(Options options)	The configuration options that control the behavior of the StartTaskExecution operation.
default DescribeTaskResponse.Builder	schedule(Consumer<TaskSchedule.Builder> schedule)	The schedule used to periodically transfer files from a source to a destination location.
DescribeTaskResponse.Builder	schedule(TaskSchedule schedule)	The schedule used to periodically transfer files from a source to a destination location.
DescribeTaskResponse.Builder	sourceLocationArn(String sourceLocationArn)	The Amazon Resource Name (ARN) of the source file system's location.
DescribeTaskResponse.Builder	sourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)	The Amazon Resource Names (ARNs) of the network interfaces created for your source location.
DescribeTaskResponse.Builder	sourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)	The Amazon Resource Names (ARNs) of the network interfaces created for your source location.
DescribeTaskResponse.Builder	status(String status)	The status of the task that was described.
DescribeTaskResponse.Builder	status(TaskStatus status)	The status of the task that was described.
DescribeTaskResponse.Builder	taskArn(String taskArn)	The Amazon Resource Name (ARN) of the task that was described.
default DescribeTaskResponse.Builder	taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig)	The configuration of your task report, which provides detailed information about for your DataSync transfer.
DescribeTaskResponse.Builder	taskReportConfig(TaskReportConfig taskReportConfig)	The configuration of your task report, which provides detailed information about for your DataSync transfer.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

taskArn

DescribeTaskResponse.Builder taskArn(String taskArn)

The Amazon Resource Name (ARN) of the task that was described.

Parameters:

taskArn - The Amazon Resource Name (ARN) of the task that was described.

Returns:

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

status

DescribeTaskResponse.Builder status(String status)

The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

Parameters:

status - The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

Returns:

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

See Also:

TaskStatus, TaskStatus

status

DescribeTaskResponse.Builder status(TaskStatus status)

The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

Parameters:

status - The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

Returns:

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

See Also:

TaskStatus, TaskStatus

name

DescribeTaskResponse.Builder name(String name)

The name of the task that was described.

Parameters:

name - The name of the task that was described.

Returns:

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

currentTaskExecutionArn

DescribeTaskResponse.Builder currentTaskExecutionArn(String currentTaskExecutionArn)

The Amazon Resource Name (ARN) of the task execution that is transferring files.

Parameters:

currentTaskExecutionArn - The Amazon Resource Name (ARN) of the task execution that is transferring files.

Returns:

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

sourceLocationArn

DescribeTaskResponse.Builder sourceLocationArn(String sourceLocationArn)

The Amazon Resource Name (ARN) of the source file system's location.

Parameters:

sourceLocationArn - The Amazon Resource Name (ARN) of the source file system's location.

Returns:

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

destinationLocationArn

DescribeTaskResponse.Builder destinationLocationArn(String destinationLocationArn)

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

Parameters:

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

Returns:

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

cloudWatchLogGroupArn

DescribeTaskResponse.Builder cloudWatchLogGroupArn(String cloudWatchLogGroupArn)

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

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

Parameters:

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

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

Returns:

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

sourceNetworkInterfaceArns

DescribeTaskResponse.Builder sourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)

The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

Parameters:

sourceNetworkInterfaceArns - The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

Returns:

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

sourceNetworkInterfaceArns

DescribeTaskResponse.Builder sourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)

The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

Parameters:

sourceNetworkInterfaceArns - The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

Returns:

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

destinationNetworkInterfaceArns

DescribeTaskResponse.Builder destinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)

The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

Parameters:

destinationNetworkInterfaceArns - The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

Returns:

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

destinationNetworkInterfaceArns

DescribeTaskResponse.Builder destinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)

The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

Parameters:

destinationNetworkInterfaceArns - The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

Returns:

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

options

DescribeTaskResponse.Builder options(Options options)

The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

You can override these options for each task execution. For more information, see StartTaskExecution.

Parameters:

options - The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

You can override these options for each task execution. For more information, see StartTaskExecution.

Returns:

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

options

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

The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

You can override these options for each 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

DescribeTaskResponse.Builder excludes(Collection<FilterRule> excludes)

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

DescribeTaskResponse.Builder excludes(FilterRule... excludes)

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

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

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

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)

schedule

DescribeTaskResponse.Builder schedule(TaskSchedule schedule)

The schedule used to periodically transfer files from a source to a destination location.

Parameters:

schedule - The schedule used to periodically transfer files from a source to a destination location.

Returns:

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

schedule

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

The schedule used to periodically transfer files from a source to a destination location.

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)

errorCode

DescribeTaskResponse.Builder errorCode(String errorCode)

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

Parameters:

errorCode - Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

Returns:

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

errorDetail

DescribeTaskResponse.Builder errorDetail(String errorDetail)

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

Parameters:

errorDetail - Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

Returns:

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

creationTime

DescribeTaskResponse.Builder creationTime(Instant creationTime)

The time that the task was created.

Parameters:

creationTime - The time that the task was created.

Returns:

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

includes

DescribeTaskResponse.Builder includes(Collection<FilterRule> includes)

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

DescribeTaskResponse.Builder includes(FilterRule... includes)

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

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

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

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)

manifestConfig

DescribeTaskResponse.Builder manifestConfig(ManifestConfig manifestConfig)

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

Parameters:

manifestConfig - The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

Returns:

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

manifestConfig

default DescribeTaskResponse.Builder manifestConfig(Consumer<ManifestConfig.Builder> manifestConfig)

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

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

DescribeTaskResponse.Builder taskReportConfig(TaskReportConfig taskReportConfig)

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

Parameters:

taskReportConfig - The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

Returns:

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

taskReportConfig

default DescribeTaskResponse.Builder taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig)

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

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)