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

Class DescribeTaskExecutionResponse

    • Method Detail

      • taskExecutionArn

        public final 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.

        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.

      • options

        public final Options options()
        Returns the value of the Options property for this object.
        Returns:
        The value of the Options property for this object.

      • hasExcludes

        public final boolean hasExcludes()
        For responses, this returns true if the service returned a value for the Excludes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • excludes

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludes() method.

        Returns:
        A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

      • hasIncludes

        public final boolean hasIncludes()
        For responses, this returns true if the service returned a value for the Includes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • includes

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludes() method.

        Returns:
        A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

      • startTime

        public final Instant startTime()

        The time when the task execution started.

        Returns:
        The time when the task execution started.

      • estimatedFilesToTransfer

        public final 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.

        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.

      • estimatedBytesToTransfer

        public final Long estimatedBytesToTransfer()

        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.

      • filesTransferred

        public final 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.

        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.

      • bytesWritten

        public final Long bytesWritten()

        The number of logical bytes written to the destination location.

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

      • bytesTransferred

        public final Long bytesTransferred()

        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.

      • result

        public final TaskExecutionResultDetail result()

        The result of the task execution.

        Returns:
        The result of the task execution.

      • bytesCompressed

        public final 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.

        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.

      • taskReportConfig

        public final TaskReportConfig taskReportConfig()

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

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

      • filesDeleted

        public final 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.

        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.

      • filesSkipped

        public final Long filesSkipped()

        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.

      • filesVerified

        public final 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.

        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.

      • reportResult

        public final ReportResult reportResult()

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

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

      • estimatedFilesToDelete

        public final 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.

        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.

      • toString

        public final 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