software.amazon.awssdk.services.datasync.model

Interface DescribeTaskExecutionResponse.Builder

All Superinterfaces:

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

Enclosing class:

DescribeTaskExecutionResponse

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

Method Summary

Modifier and Type	Method and Description
DescribeTaskExecutionResponse.Builder	bytesCompressed(Long bytesCompressed) The physical number of bytes transferred over the network after compression was applied.
DescribeTaskExecutionResponse.Builder	bytesTransferred(Long bytesTransferred) The total number of bytes that are involved in the transfer.
DescribeTaskExecutionResponse.Builder	bytesWritten(Long bytesWritten) The number of logical bytes written to the destination Amazon Web Services storage resource.
DescribeTaskExecutionResponse.Builder	estimatedBytesToTransfer(Long estimatedBytesToTransfer) The estimated physical number of bytes that is to be transferred over the network.
DescribeTaskExecutionResponse.Builder	estimatedFilesToTransfer(Long estimatedFilesToTransfer) The expected number of files that is to be transferred over the network.
DescribeTaskExecutionResponse.Builder	excludes(Collection<FilterRule> excludes) A list of filter rules that exclude specific data during your transfer.
DescribeTaskExecutionResponse.Builder	excludes(Consumer<FilterRule.Builder>... excludes) A list of filter rules that exclude specific data during your transfer.
DescribeTaskExecutionResponse.Builder	excludes(FilterRule... excludes) A list of filter rules that exclude specific data during your transfer.
DescribeTaskExecutionResponse.Builder	filesTransferred(Long filesTransferred) The actual number of files that was transferred over the network.
DescribeTaskExecutionResponse.Builder	includes(Collection<FilterRule> includes) A list of filter rules that include specific data during your transfer.
DescribeTaskExecutionResponse.Builder	includes(Consumer<FilterRule.Builder>... includes) A list of filter rules that include specific data during your transfer.
DescribeTaskExecutionResponse.Builder	includes(FilterRule... includes) A list of filter rules that include specific data during your transfer.
default DescribeTaskExecutionResponse.Builder	options(Consumer<Options.Builder> options) Sets the value of the Options property for this object.
DescribeTaskExecutionResponse.Builder	options(Options options) Sets the value of the Options property for this object.
default DescribeTaskExecutionResponse.Builder	result(Consumer<TaskExecutionResultDetail.Builder> result) The result of the task execution.
DescribeTaskExecutionResponse.Builder	result(TaskExecutionResultDetail result) The result of the task execution.
DescribeTaskExecutionResponse.Builder	startTime(Instant startTime) The time that the task execution was started.
DescribeTaskExecutionResponse.Builder	status(String status) The status of the task execution.
DescribeTaskExecutionResponse.Builder	status(TaskExecutionStatus status) The status of the task execution.
DescribeTaskExecutionResponse.Builder	taskExecutionArn(String taskExecutionArn) The Amazon Resource Name (ARN) of the task execution 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

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

taskExecutionArn

DescribeTaskExecutionResponse.Builder taskExecutionArn(String taskExecutionArn)

The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

Parameters:

taskExecutionArn - The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

Returns:

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

status

DescribeTaskExecutionResponse.Builder status(String status)

The status of the task execution.

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

Parameters:

status - The status of the task execution.

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:

TaskExecutionStatus, TaskExecutionStatus

status

DescribeTaskExecutionResponse.Builder status(TaskExecutionStatus status)

The status of the task execution.

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

Parameters:

status - The status of the task execution.

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:

TaskExecutionStatus, TaskExecutionStatus

options

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

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

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

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

includes

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

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

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

startTime

DescribeTaskExecutionResponse.Builder startTime(Instant startTime)

The time that the task execution was started.

Parameters:

startTime - The time that the task execution was started.

Returns:

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

estimatedFilesToTransfer

DescribeTaskExecutionResponse.Builder estimatedFilesToTransfer(Long estimatedFilesToTransfer)

The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase before the TRANSFERRING phase of the task execution. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

Parameters:

estimatedFilesToTransfer - The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase before the TRANSFERRING phase of the task execution. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

Returns:

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

estimatedBytesToTransfer

DescribeTaskExecutionResponse.Builder estimatedBytesToTransfer(Long estimatedBytesToTransfer)

The estimated physical number of bytes that is to be transferred over the network.

Parameters:

estimatedBytesToTransfer - The estimated physical number of bytes that is to be transferred over the network.

Returns:

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

filesTransferred

DescribeTaskExecutionResponse.Builder filesTransferred(Long filesTransferred)

The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase of the task execution. It's updated periodically when each file is read from the source and sent over the network.

If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

Parameters:

filesTransferred - The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase of the task execution. It's updated periodically when each file is read from the source and sent over the network.

If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer . In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

Returns:

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

bytesWritten

DescribeTaskExecutionResponse.Builder bytesWritten(Long bytesWritten)

The number of logical bytes written to the destination Amazon Web Services storage resource.

Parameters:

bytesWritten - The number of logical bytes written to the destination Amazon Web Services storage resource.

Returns:

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

bytesTransferred

DescribeTaskExecutionResponse.Builder bytesTransferred(Long bytesTransferred)

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

Parameters:

bytesTransferred - The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

Returns:

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

result

DescribeTaskExecutionResponse.Builder result(TaskExecutionResultDetail result)

The result of the task execution.

Parameters:

result - The result of the task execution.

Returns:

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

result

default DescribeTaskExecutionResponse.Builder result(Consumer<TaskExecutionResultDetail.Builder> result)

The result of the task execution.

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

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

Parameters:

result - a consumer that will call methods on TaskExecutionResultDetail.Builder

Returns:

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

See Also:

result(TaskExecutionResultDetail)

bytesCompressed

DescribeTaskExecutionResponse.Builder bytesCompressed(Long bytesCompressed)

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn't compressible.

Parameters:

bytesCompressed - The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn't compressible.

Returns:

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