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

    • taskExecutionArn

      DescribeTaskExecutionResponse.Builder taskExecutionArn(String taskExecutionArn)

      The ARN of the task execution that you wanted information about. 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 ARN of the task execution that you wanted information about. 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.

      Parameters:
      status - The status of the task execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeTaskExecutionResponse.Builder status(TaskExecutionStatus status)

      The status of the task execution.

      Parameters:
      status - The status of the task execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

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

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

    • startTime

      DescribeTaskExecutionResponse.Builder startTime(Instant startTime)

      The time when the task execution started.

      Parameters:
      startTime - The time when the task execution 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, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

      Parameters:
      estimatedFilesToTransfer - The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference 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 will transfer over the network.

      Parameters:
      estimatedBytesToTransfer - The estimated physical number of bytes that will transfer 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, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

      If DataSync fails to transfer something, 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 exact indication of what transferred or to monitor your task execution.

      Parameters:
      filesTransferred - The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

      If DataSync fails to transfer something, 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 exact indication of what transferred 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 location.

      Parameters:
      bytesWritten - The number of logical bytes written to the destination location.
      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:

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

    • taskReportConfig

      DescribeTaskExecutionResponse.Builder taskReportConfig(TaskReportConfig taskReportConfig)

      The configuration of your task report, which provides detailed information about for your DataSync transfer.

      Parameters:
      taskReportConfig - The configuration of your task report, which provides detailed information about for your DataSync transfer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskReportConfig

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

      The configuration of your task report, which provides detailed information about for your DataSync transfer.

      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:

    • filesDeleted

      DescribeTaskExecutionResponse.Builder filesDeleted(Long filesDeleted)

      The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

      Parameters:
      filesDeleted - The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filesSkipped

      DescribeTaskExecutionResponse.Builder filesSkipped(Long filesSkipped)

      The number of files, objects, and directories that DataSync skipped during your transfer.

      Parameters:
      filesSkipped - The number of files, objects, and directories that DataSync skipped during your transfer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filesVerified

      DescribeTaskExecutionResponse.Builder filesVerified(Long filesVerified)

      The number of files, objects, and directories that DataSync verified during your transfer.

      When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

      Parameters:
      filesVerified - The number of files, objects, and directories that DataSync verified during your transfer.

      When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

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

    • reportResult

      DescribeTaskExecutionResponse.Builder reportResult(ReportResult reportResult)

      Indicates whether DataSync generated a complete task report for your transfer.

      Parameters:
      reportResult - Indicates whether DataSync generated a complete task report for your transfer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportResult

      default DescribeTaskExecutionResponse.Builder reportResult(Consumer<ReportResult.Builder> reportResult)

      Indicates whether DataSync generated a complete task report for your transfer.

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

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

      Parameters:
      reportResult - a consumer that will call methods on ReportResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • estimatedFilesToDelete

      DescribeTaskExecutionResponse.Builder estimatedFilesToDelete(Long estimatedFilesToDelete)

      The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

      Parameters:
      estimatedFilesToDelete - The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.