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 an Amazon CloudWatch log group for monitoring your task.
DescribeTaskResponse.Builder	creationTime(Instant creationTime)	The time that the task was created.
DescribeTaskResponse.Builder	currentTaskExecutionArn(String currentTaskExecutionArn)	The ARN of the most recent task execution.
DescribeTaskResponse.Builder	destinationLocationArn(String destinationLocationArn)	The ARN of your transfer's destination location.
DescribeTaskResponse.Builder	destinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)	The ARNs of the network interfaces that DataSync created for your destination location.
DescribeTaskResponse.Builder	destinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)	The ARNs of the network interfaces that DataSync created for your destination location.
DescribeTaskResponse.Builder	errorCode(String errorCode)	If there's an issue with your task, you can use the error code to help you troubleshoot the problem.
DescribeTaskResponse.Builder	errorDetail(String errorDetail)	If there's an issue with your task, you can use the error details to help you troubleshoot the problem.
DescribeTaskResponse.Builder	excludes(Collection<FilterRule> excludes)	The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
DescribeTaskResponse.Builder	excludes(Consumer<FilterRule.Builder>... excludes)	The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
DescribeTaskResponse.Builder	excludes(FilterRule... excludes)	The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
DescribeTaskResponse.Builder	includes(Collection<FilterRule> includes)	The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
DescribeTaskResponse.Builder	includes(Consumer<FilterRule.Builder>... includes)	The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
DescribeTaskResponse.Builder	includes(FilterRule... includes)	The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
default DescribeTaskResponse.Builder	manifestConfig(Consumer<ManifestConfig.Builder> manifestConfig)	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
DescribeTaskResponse.Builder	manifestConfig(ManifestConfig manifestConfig)	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
DescribeTaskResponse.Builder	name(String name)	The name of your task.
default DescribeTaskResponse.Builder	options(Consumer<Options.Builder> options)	The task's settings.
DescribeTaskResponse.Builder	options(Options options)	The task's settings.
default DescribeTaskResponse.Builder	schedule(Consumer<TaskSchedule.Builder> schedule)	The schedule for when you want your task to run.
DescribeTaskResponse.Builder	schedule(TaskSchedule schedule)	The schedule for when you want your task to run.
default DescribeTaskResponse.Builder	scheduleDetails(Consumer<TaskScheduleDetails.Builder> scheduleDetails)	The details about your task schedule.
DescribeTaskResponse.Builder	scheduleDetails(TaskScheduleDetails scheduleDetails)	The details about your task schedule.
DescribeTaskResponse.Builder	sourceLocationArn(String sourceLocationArn)	The ARN of your transfer's source location.
DescribeTaskResponse.Builder	sourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)	The ARNs of the network interfaces that DataSync created for your source location.
DescribeTaskResponse.Builder	sourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)	The ARNs of the network interfaces that DataSync created for your source location.
DescribeTaskResponse.Builder	status(String status)	The status of your task.
DescribeTaskResponse.Builder	status(TaskStatus status)	The status of your task.
DescribeTaskResponse.Builder	taskArn(String taskArn)	The ARN of your task.
default DescribeTaskResponse.Builder	taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig)	The configuration of your task report, which provides detailed information about your DataSync transfer.
DescribeTaskResponse.Builder	taskReportConfig(TaskReportConfig taskReportConfig)	The configuration of your task report, which provides detailed information about 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 Details

taskArn

DescribeTaskResponse.Builder taskArn(String taskArn)

The ARN of your task.

Parameters:

taskArn - The ARN of your task.

Returns:

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

status

DescribeTaskResponse.Builder status(String status)

The status of your task. For information about what each status means, see Task statuses.

Parameters:

status - The status of your task. For information about what each status means, see Task statuses.

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 your task. For information about what each status means, see Task statuses.

Parameters:

status - The status of your task. For information about what each status means, see Task statuses.

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 your task.

Parameters:

name - The name of your task.

Returns:

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

currentTaskExecutionArn

DescribeTaskResponse.Builder currentTaskExecutionArn(String currentTaskExecutionArn)

The ARN of the most recent task execution.

Parameters:

currentTaskExecutionArn - The ARN of the most recent task execution.

Returns:

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

sourceLocationArn

DescribeTaskResponse.Builder sourceLocationArn(String sourceLocationArn)

The ARN of your transfer's source location.

Parameters:

sourceLocationArn - The ARN of your transfer's source location.

Returns:

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

destinationLocationArn

DescribeTaskResponse.Builder destinationLocationArn(String destinationLocationArn)

The ARN of your transfer's destination location.

Parameters:

destinationLocationArn - The ARN of your transfer's destination 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 an Amazon CloudWatch log group for monitoring your task.

For more information, see Monitoring DataSync with Amazon CloudWatch.

Parameters:

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

For more information, see Monitoring DataSync with Amazon CloudWatch.

Returns:

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

sourceNetworkInterfaceArns

DescribeTaskResponse.Builder sourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)

The ARNs of the network interfaces that DataSync created for your source location.

Parameters:

sourceNetworkInterfaceArns - The ARNs of the network interfaces that DataSync created for your source location.

Returns:

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

sourceNetworkInterfaceArns

DescribeTaskResponse.Builder sourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)

The ARNs of the network interfaces that DataSync created for your source location.

Parameters:

sourceNetworkInterfaceArns - The ARNs of the network interfaces that DataSync created for your source location.

Returns:

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

destinationNetworkInterfaceArns

DescribeTaskResponse.Builder destinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)

The ARNs of the network interfaces that DataSync created for your destination location.

Parameters:

destinationNetworkInterfaceArns - The ARNs of the network interfaces that DataSync created for your destination location.

Returns:

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

destinationNetworkInterfaceArns

DescribeTaskResponse.Builder destinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)

The ARNs of the network interfaces that DataSync created for your destination location.

Parameters:

destinationNetworkInterfaceArns - The ARNs of the network interfaces that DataSync created for your destination location.

Returns:

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

options

DescribeTaskResponse.Builder options(Options options)

The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

Parameters:

options - The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

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 task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, 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

DescribeTaskResponse.Builder excludes(Collection<FilterRule> excludes)

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

DescribeTaskResponse.Builder excludes(FilterRule... excludes)

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

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

The 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

DescribeTaskResponse.Builder schedule(TaskSchedule schedule)

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

Parameters:

schedule - The 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 DescribeTaskResponse.Builder schedule(Consumer<TaskSchedule.Builder> schedule)

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

errorCode

DescribeTaskResponse.Builder errorCode(String errorCode)

If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

Parameters:

errorCode - If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

Returns:

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

errorDetail

DescribeTaskResponse.Builder errorDetail(String errorDetail)

If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

Parameters:

errorDetail - If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

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)

The include filters that 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 - The include filters that 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

DescribeTaskResponse.Builder includes(FilterRule... includes)

The include filters that 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 - The include filters that 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

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

The include filters that 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

DescribeTaskResponse.Builder manifestConfig(ManifestConfig manifestConfig)

The configuration of the manifest that lists the files or objects that you want DataSync 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 that you want DataSync 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 that you want DataSync 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 your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

Parameters:

taskReportConfig - The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

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 your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

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)

scheduleDetails

DescribeTaskResponse.Builder scheduleDetails(TaskScheduleDetails scheduleDetails)

The details about your task schedule.

Parameters:

scheduleDetails - The details about your task schedule.

Returns:

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

scheduleDetails

default DescribeTaskResponse.Builder scheduleDetails(Consumer<TaskScheduleDetails.Builder> scheduleDetails)

The details about your task schedule.

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

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

Parameters:

scheduleDetails - a consumer that will call methods on TaskScheduleDetails.Builder

Returns:

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

See Also:

• scheduleDetails(TaskScheduleDetails)