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

Interface DescribeTaskExecutionResponse.Builder

    • Method Detail

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

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

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

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

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

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