software.amazon.awssdk.services.datasync.model

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(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

Method Summary

Modifier and Type	Method and Description
static DescribeTaskExecutionResponse.Builder	builder()
Long	bytesTransferred() The physical number of bytes transferred over the network.
Long	bytesWritten() The number of logical bytes written to the destination AWS storage resource.
boolean	equals(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.
Long	filesTransferred() The actual number of files that was transferred over the network.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
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.
String	statusAsString() The status of the task.
String	taskExecutionArn() The Amazon Resource Name (ARN) of the task execution that was described.
DescribeTaskExecutionResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

taskExecutionArn

public 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:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:sync:us-east-1:209870788375: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:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2.

status

public TaskExecutionStatus status()

The status of the task. For detailed information about sync statuses, see Understanding Sync Task Statuses.

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. For detailed information about sync statuses, see Understanding Sync Task Statuses.

See Also:

TaskExecutionStatus

statusAsString

public String statusAsString()

The status of the task. For detailed information about sync statuses, see Understanding Sync Task Statuses.

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. For detailed information about sync statuses, see Understanding Sync Task Statuses.

See Also:

TaskExecutionStatus

options

public Options options()

Returns the value of the Options property for this object.

Returns:

The value of the Options property for this object.

startTime

public Instant startTime()

The time that the task execution was started.

Returns:

The time that the task execution was started.

estimatedFilesToTransfer

public 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 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 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 Long bytesWritten()

The number of logical bytes written to the destination AWS storage resource.

Returns:

The number of logical bytes written to the destination AWS storage resource.

bytesTransferred

public Long bytesTransferred()

The physical number of bytes transferred over the network.

Returns:

The physical number of bytes transferred over the network.

result

public TaskExecutionResultDetail result()

The result of the task execution.

Returns:

The result of the task execution.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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