Class TaskExecutionResultDetail

java.lang.Object

software.amazon.awssdk.services.datasync.model.TaskExecutionResultDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskExecutionResultDetail.Builder,TaskExecutionResultDetail>

@Generated("software.amazon.awssdk:codegen")
public final class TaskExecutionResultDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TaskExecutionResultDetail.Builder,TaskExecutionResultDetail>

Provides detailed information about the result of your DataSync task execution.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TaskExecutionResultDetail.Builder

Method Summary

Modifier and Type	Method	Description
static TaskExecutionResultDetail.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final String	errorCode()	An error that DataSync encountered during your task execution.
final String	errorDetail()	The detailed description of an error that DataSync encountered during your task execution.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Long	prepareDuration()	The time in milliseconds that your task execution was in the PREPARING step.
final PhaseStatus	prepareStatus()	The status of the PREPARING step for your task execution.
final String	prepareStatusAsString()	The status of the PREPARING step for your task execution.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends TaskExecutionResultDetail.Builder>	serializableBuilderClass()
TaskExecutionResultDetail.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final Long	totalDuration()	The time in milliseconds that your task execution ran.
final Long	transferDuration()	The time in milliseconds that your task execution was in the TRANSFERRING step.
final PhaseStatus	transferStatus()	The status of the TRANSFERRING step for your task execution.
final String	transferStatusAsString()	The status of the TRANSFERRING step for your task execution.
final Long	verifyDuration()	The time in milliseconds that your task execution was in the VERIFYING step.
final PhaseStatus	verifyStatus()	The status of the VERIFYING step for your task execution.
final String	verifyStatusAsString()	The status of the VERIFYING step for your task execution.

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 Details

prepareDuration

public final Long prepareDuration()

The time in milliseconds that your task execution was in the PREPARING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync prepares your data transfer.

Returns:

The time in milliseconds that your task execution was in the PREPARING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync prepares your data transfer.

prepareStatus

public final PhaseStatus prepareStatus()

The status of the PREPARING step for your task execution. For more information, see Task execution statuses.

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

Returns:

The status of the PREPARING step for your task execution. For more information, see Task execution statuses.

See Also:

• PhaseStatus

prepareStatusAsString

public final String prepareStatusAsString()

The status of the PREPARING step for your task execution. For more information, see Task execution statuses.

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

Returns:

The status of the PREPARING step for your task execution. For more information, see Task execution statuses.

See Also:

• PhaseStatus

totalDuration

public final Long totalDuration()

The time in milliseconds that your task execution ran.

Returns:

The time in milliseconds that your task execution ran.

transferDuration

public final Long transferDuration()

The time in milliseconds that your task execution was in the TRANSFERRING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync transfers your data.

Returns:

The time in milliseconds that your task execution was in the TRANSFERRING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync transfers your data.

transferStatus

public final PhaseStatus transferStatus()

The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses.

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

Returns:

The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses.

See Also:

• PhaseStatus

transferStatusAsString

public final String transferStatusAsString()

The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses.

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

Returns:

The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses.

See Also:

• PhaseStatus

verifyDuration

public final Long verifyDuration()

The time in milliseconds that your task execution was in the VERIFYING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync verifies your data's integrity.

Returns:

The time in milliseconds that your task execution was in the VERIFYING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync verifies your data's integrity.

verifyStatus

public final PhaseStatus verifyStatus()

The status of the VERIFYING step for your task execution. For more information, see Task execution statuses.

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

Returns:

The status of the VERIFYING step for your task execution. For more information, see Task execution statuses.

See Also:

• PhaseStatus

verifyStatusAsString

public final String verifyStatusAsString()

The status of the VERIFYING step for your task execution. For more information, see Task execution statuses.

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

Returns:

The status of the VERIFYING step for your task execution. For more information, see Task execution statuses.

See Also:

• PhaseStatus

errorCode

public final String errorCode()

An error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

Returns:

An error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

errorDetail

public final String errorDetail()

The detailed description of an error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

Returns:

The detailed description of an error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

toBuilder

public TaskExecutionResultDetail.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<TaskExecutionResultDetail.Builder,TaskExecutionResultDetail>

Returns:

a builder for type T

builder

public static TaskExecutionResultDetail.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.