DescribeTaskExecutionResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeTaskExecutionResponse
extends DataSyncResponse
implements ToCopyableBuilder<DescribeTaskExecutionResponse.Builder,DescribeTaskExecutionResponse>

DescribeTaskExecutionResponse

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeTaskExecutionResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeTaskExecutionResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeTaskExecutionResponse.Builder`	`builder()`
`Long`	`bytesCompressed()` The physical number of bytes transferred over the network after compression was applied.
`Long`	`bytesTransferred()` The physical number of bytes transferred over the network.
`Long`	`bytesWritten()` The number of logical bytes written to the destination Amazon Web Services storage resource.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`estimatedBytesToTransfer()` The estimated physical number of bytes that is to be transferred over the network.
`Long`	`estimatedFilesToTransfer()` The expected number of files that is to be transferred over the network.
`List<FilterRule>`	`excludes()` A list of filter rules that determines which files to exclude from a task.
`Long`	`filesTransferred()` The actual number of files that was transferred over the network.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExcludes()` For responses, this returns true if the service returned a value for the Excludes property.
`int`	`hashCode()`
`boolean`	`hasIncludes()` For responses, this returns true if the service returned a value for the Includes property.
`List<FilterRule>`	`includes()` A list of filter rules that determines which files to include when running a task.
`Options`	`options()` Returns the value of the Options property for this object.
`TaskExecutionResultDetail`	`result()` The result of the task execution.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeTaskExecutionResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The time that the task execution was started.
`TaskExecutionStatus`	`status()` The status of the task execution.
`String`	`statusAsString()` The status of the task execution.
`String`	`taskExecutionArn()` The Amazon Resource Name (ARN) of the task execution that was described.
`DescribeTaskExecutionResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.datasync.model.DataSyncResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - taskExecutionArn
```
public final String taskExecutionArn()
```
    The Amazon Resource Name (ARN) of the task execution that was described. 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 Amazon Resource Name (ARN) of the task execution that was described. 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.
    
    For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
    
    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.
    
    For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
    
    See Also:
    
    TaskExecutionStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the task execution.
    
    For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
    
    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.
    
    For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
    
    See Also:
    
    TaskExecutionStatus
  - 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 determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"
    
    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 determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"
  - 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 determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"
    
    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 determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"
  - startTime
```
public final Instant startTime()
```
    The time that the task execution was started.
    
    Returns:
    
    The time that the task execution was started.
  - estimatedFilesToTransfer
```
public final Long estimatedFilesToTransfer()
```
    The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.
    
    Returns:
    
    The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.
  - estimatedBytesToTransfer
```
public final Long estimatedBytesToTransfer()
```
    The estimated physical number of bytes that is to be transferred over the network.
    
    Returns:
    
    The estimated physical number of bytes that is to be transferred over the network.
  - filesTransferred
```
public final Long filesTransferred()
```
    The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.
    
    If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.
    
    Returns:
    
    The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.
    
    If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.
  - bytesWritten
```
public final Long bytesWritten()
```
    The number of logical bytes written to the destination Amazon Web Services storage resource.
    
    Returns:
    
    The number of logical bytes written to the destination Amazon Web Services storage resource.
  - bytesTransferred
```
public final Long bytesTransferred()
```
    The physical number of bytes transferred over the network.
    
    Returns:
    
    The physical number of bytes transferred over the network.
  - 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.
    
    Returns:
    
    The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred.
  - toBuilder
```
public DescribeTaskExecutionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeTaskExecutionResponse.Builder,DescribeTaskExecutionResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeTaskExecutionResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.datasync.model.DataSyncResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

taskExecutionArn

status

statusAsString

options

hasExcludes

excludes

hasIncludes

includes

startTime

estimatedFilesToTransfer

estimatedBytesToTransfer

filesTransferred

bytesWritten

bytesTransferred

result

bytesCompressed

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields