Class DescribeTaskExecutionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.datasync.model.DataSyncResponse
software.amazon.awssdk.services.datasync.model.DescribeTaskExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeTaskExecutionResponse.Builder,DescribeTaskExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeTaskExecutionResponse extends DataSyncResponse implements ToCopyableBuilder<DescribeTaskExecutionResponse.Builder,DescribeTaskExecutionResponse>

DescribeTaskExecutionResponse

  • Method Details

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

    • status

      public final TaskExecutionStatus status()

      The status of the task execution.

      If the service returns an enum value that is not available in the current SDK version, status will return TaskExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the task execution.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the task execution.

      If the service returns an enum value that is not available in the current SDK version, status will return TaskExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the task execution.
      See Also:

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

    • manifestConfig

      public final ManifestConfig manifestConfig()

      The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

      Returns:
      The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

    • startTime

      public final Instant startTime()

      The time that DataSync sends the request to start the task execution. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

      Returns:
      The time that DataSync sends the request to start the task execution. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

    • estimatedFilesToTransfer

      public final Long estimatedFilesToTransfer()

      The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.

      How this gets calculated depends primarily on your task’s transfer mode configuration:

      • If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:

        • Anything that's added or modified at the source location.

        • Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).

        • (Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE).

      • If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.

      Returns:
      The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.

      How this gets calculated depends primarily on your task’s transfer mode configuration:

      • If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:

        • Anything that's added or modified at the source location.

        • Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).

        • (Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE).

      • If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.

    • estimatedBytesToTransfer

      public final Long estimatedBytesToTransfer()

      The number of logical bytes that DataSync expects to write to the destination location.

      Returns:
      The number of logical bytes that DataSync expects to write to the destination location.

    • filesTransferred

      public final Long filesTransferred()

      The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution 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's transferring or to monitor your task execution.

      Returns:
      The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution 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's transferring or to monitor your task execution.

    • bytesWritten

      public final Long bytesWritten()

      The number of logical bytes that DataSync actually writes to the destination location.

      Returns:
      The number of logical bytes that DataSync actually writes to the destination location.

    • bytesTransferred

      public final Long bytesTransferred()

      The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.

      Returns:
      The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.

    • bytesCompressed

      public final Long bytesCompressed()

      The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.

      Returns:
      The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.

    • result

      public final TaskExecutionResultDetail result()

      The result of the task execution.

      Returns:
      The result of the task execution.

    • taskReportConfig

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

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

    • filesDeleted

      public final Long filesDeleted()

      The number of files, objects, and directories that DataSync actually deletes 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 actually deletes 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 skips during your transfer.

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

    • filesVerified

      public final Long filesVerified()

      The number of files, objects, and directories that DataSync verifies 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 verifies 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 number of files, objects, and directories that DataSync expects to 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 number of files, objects, and directories that DataSync expects to 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.

    • taskMode

      public final TaskMode taskMode()

      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

      If the service returns an enum value that is not available in the current SDK version, taskMode will return TaskMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskModeAsString().

      Returns:
      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
      See Also:

    • taskModeAsString

      public final String taskModeAsString()

      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

      If the service returns an enum value that is not available in the current SDK version, taskMode will return TaskMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskModeAsString().

      Returns:
      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
      See Also:

    • filesPrepared

      public final Long filesPrepared()

      The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.

      Applies only to Enhanced mode tasks.

      This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

      Returns:
      The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.

      Applies only to Enhanced mode tasks.

      This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

    • filesListed

      public final TaskExecutionFilesListedDetail filesListed()

      The number of objects that DataSync finds at your locations.

      Applies only to Enhanced mode tasks.

      Returns:
      The number of objects that DataSync finds at your locations.

      Applies only to Enhanced mode tasks.

    • filesFailed

      public final TaskExecutionFilesFailedDetail filesFailed()

      The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.

      Applies only to Enhanced mode tasks.

      Returns:
      The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.

      Applies only to Enhanced mode tasks.

    • launchTime

      public final Instant launchTime()

      The time that the task execution actually begins. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

      Returns:
      The time that the task execution actually begins. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

    • endTime

      public final Instant endTime()

      The time that the transfer task ends.

      Returns:
      The time that the transfer task ends.

    • toBuilder

      public DescribeTaskExecutionResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeTaskExecutionResponse.Builder,DescribeTaskExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeTaskExecutionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeTaskExecutionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.