JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.datasync.model

Class DescribeTaskExecutionResult

    • Constructor Detail

      • DescribeTaskExecutionResult

        public DescribeTaskExecutionResult()
    • Method Detail

      • setTaskExecutionArn

        public void setTaskExecutionArn(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.

      • getTaskExecutionArn

        public String getTaskExecutionArn()

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

      • withTaskExecutionArn

        public DescribeTaskExecutionResult withTaskExecutionArn(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.
      • setStatus

        public void setStatus(String status)

        The status of the task execution.

        Parameters:
        status - The status of the task execution.
        See Also:
        TaskExecutionStatus
      • getStatus

        public String getStatus()

        The status of the task execution.

        Returns:
        The status of the task execution.
        See Also:
        TaskExecutionStatus
      • withStatus

        public DescribeTaskExecutionResult withStatus(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:
        TaskExecutionStatus
      • setOptions

        public void setOptions(Options options)
        Parameters:
        options -
      • getOptions

        public Options getOptions()
        Returns:
      • withOptions

        public DescribeTaskExecutionResult withOptions(Options options)
        Parameters:
        options -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStartTime

        public void setStartTime(Date startTime)

        The time when the task execution started.

        Parameters:
        startTime - The time when the task execution started.
      • getStartTime

        public Date getStartTime()

        The time when the task execution started.

        Returns:
        The time when the task execution started.
      • withStartTime

        public DescribeTaskExecutionResult withStartTime(Date 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.
      • setEstimatedFilesToTransfer

        public void setEstimatedFilesToTransfer(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.
      • getEstimatedFilesToTransfer

        public Long getEstimatedFilesToTransfer()

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

        public DescribeTaskExecutionResult withEstimatedFilesToTransfer(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.
      • setEstimatedBytesToTransfer

        public void setEstimatedBytesToTransfer(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.
      • getEstimatedBytesToTransfer

        public Long getEstimatedBytesToTransfer()

        The estimated physical number of bytes that will transfer over the network.

        Returns:
        The estimated physical number of bytes that will transfer over the network.
      • withEstimatedBytesToTransfer

        public DescribeTaskExecutionResult withEstimatedBytesToTransfer(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.
      • setFilesTransferred

        public void setFilesTransferred(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.

      • getFilesTransferred

        public Long getFilesTransferred()

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

      • withFilesTransferred

        public DescribeTaskExecutionResult withFilesTransferred(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.
      • setBytesWritten

        public void setBytesWritten(Long bytesWritten)

        The number of logical bytes written to the destination location.

        Parameters:
        bytesWritten - The number of logical bytes written to the destination location.
      • getBytesWritten

        public Long getBytesWritten()

        The number of logical bytes written to the destination location.

        Returns:
        The number of logical bytes written to the destination location.
      • withBytesWritten

        public DescribeTaskExecutionResult withBytesWritten(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.
      • setBytesTransferred

        public void setBytesTransferred(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.
      • getBytesTransferred

        public Long getBytesTransferred()

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

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

        public DescribeTaskExecutionResult withBytesTransferred(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.
      • setBytesCompressed

        public void setBytesCompressed(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.
      • getBytesCompressed

        public Long getBytesCompressed()

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

        public DescribeTaskExecutionResult withBytesCompressed(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.
      • setResult

        public void setResult(TaskExecutionResultDetail result)

        The result of the task execution.

        Parameters:
        result - The result of the task execution.
      • getResult

        public TaskExecutionResultDetail getResult()

        The result of the task execution.

        Returns:
        The result of the task execution.
      • withResult

        public DescribeTaskExecutionResult withResult(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.
      • setTaskReportConfig

        public void setTaskReportConfig(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.
      • getTaskReportConfig

        public TaskReportConfig getTaskReportConfig()

        The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

        Returns:
        The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.
      • withTaskReportConfig

        public DescribeTaskExecutionResult withTaskReportConfig(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.
      • setFilesDeleted

        public void setFilesDeleted(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.
      • getFilesDeleted

        public Long getFilesDeleted()

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

        public DescribeTaskExecutionResult withFilesDeleted(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.
      • setFilesSkipped

        public void setFilesSkipped(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.
      • getFilesSkipped

        public Long getFilesSkipped()

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

        Returns:
        The number of files, objects, and directories that DataSync skipped during your transfer.
      • withFilesSkipped

        public DescribeTaskExecutionResult withFilesSkipped(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.
      • setFilesVerified

        public void setFilesVerified(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.

      • getFilesVerified

        public Long getFilesVerified()

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

      • withFilesVerified

        public DescribeTaskExecutionResult withFilesVerified(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.
      • setReportResult

        public void setReportResult(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.
      • getReportResult

        public ReportResult getReportResult()

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

        Returns:
        Indicates whether DataSync generated a complete task report for your transfer.
      • withReportResult

        public DescribeTaskExecutionResult withReportResult(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.
      • setEstimatedFilesToDelete

        public void setEstimatedFilesToDelete(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.
      • getEstimatedFilesToDelete

        public Long getEstimatedFilesToDelete()

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

        public DescribeTaskExecutionResult withEstimatedFilesToDelete(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.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /