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 and 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 syncing files.
DescribeTaskResponse.Builder	destinationLocationArn(String destinationLocationArn) The Amazon Resource Name (ARN) of the AWS storage resource's location.
DescribeTaskResponse.Builder	errorCode(String errorCode) Errors that AWS 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)
DescribeTaskResponse.Builder	excludes(Consumer<FilterRule.Builder>... excludes)
DescribeTaskResponse.Builder	excludes(FilterRule... excludes)
DescribeTaskResponse.Builder	name(String name) The name of the task that was described.
default DescribeTaskResponse.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.
DescribeTaskResponse.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.
DescribeTaskResponse.Builder	sourceLocationArn(String sourceLocationArn) The Amazon Resource Name (ARN) of the source file system's 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.

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

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

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

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 "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).

Parameters:

status - The status of the task that was described.

For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding 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 the task that was described.

For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).

Parameters:

status - The status of the task that was described.

For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding 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 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 syncing files.

Parameters:

currentTaskExecutionArn - The Amazon Resource Name (ARN) of the task execution that is syncing 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 AWS storage resource's location.

Parameters:

destinationLocationArn - The Amazon Resource Name (ARN) of the AWS 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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.

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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.

Returns:

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

options

DescribeTaskResponse.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 (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to 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 (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

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 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 (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to 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

DescribeTaskResponse.Builder excludes(Collection<FilterRule> excludes)

Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Parameters:

excludes -

Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Returns:

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

excludes

DescribeTaskResponse.Builder excludes(FilterRule... excludes)

Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Parameters:

excludes -

Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Returns:

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

excludes

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

Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

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)

errorCode

DescribeTaskResponse.Builder errorCode(String errorCode)

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

Parameters:

errorCode - Errors that AWS 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.