software.amazon.awssdk.services.datasync.model

Class DescribeTaskResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeTaskResponse
extends DataSyncResponse
implements ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>

DescribeTaskResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeTaskResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeTaskResponse.Builder	builder()
String	cloudWatchLogGroupArn() The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
Instant	creationTime() The time that the task was created.
String	currentTaskExecutionArn() The Amazon Resource Name (ARN) of the task execution that is syncing files.
String	destinationLocationArn() The Amazon Resource Name (ARN) of the AWS storage resource's location.
boolean	equals(Object obj)
String	errorCode() Errors that AWS DataSync encountered during execution of the task.
String	errorDetail() Detailed description of an error that was encountered during the task execution.
<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()
String	name() The name of the task that was described.
Options	options() The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTaskResponse.Builder>	serializableBuilderClass()
String	sourceLocationArn() The Amazon Resource Name (ARN) of the source file system's location.
TaskStatus	status() The status of the task that was described.
String	statusAsString() The status of the task that was described.
String	taskArn() The Amazon Resource Name (ARN) of the task that was described.
DescribeTaskResponse.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

taskArn

public String taskArn()

The Amazon Resource Name (ARN) of the task that was described.

Returns:

The Amazon Resource Name (ARN) of the task that was described.

status

public TaskStatus status()

The status of the task that was described. 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 TaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

TaskStatus

statusAsString

public String statusAsString()

The status of the task that was described. 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 TaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

TaskStatus

name

public String name()

The name of the task that was described.

Returns:

The name of the task that was described.

currentTaskExecutionArn

public String currentTaskExecutionArn()

The Amazon Resource Name (ARN) of the task execution that is syncing files.

Returns:

The Amazon Resource Name (ARN) of the task execution that is syncing files.

sourceLocationArn

public String sourceLocationArn()

The Amazon Resource Name (ARN) of the source file system's location.

Returns:

The Amazon Resource Name (ARN) of the source file system's location.

destinationLocationArn

public String destinationLocationArn()

The Amazon Resource Name (ARN) of the AWS storage resource's location.

Returns:

The Amazon Resource Name (ARN) of the AWS storage resource's location.

cloudWatchLogGroupArn

public String cloudWatchLogGroupArn()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

Returns:

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

options

public Options options()

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

Returns:

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

errorCode

public String errorCode()

Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

Returns:

Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

errorDetail

public String errorDetail()

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

Returns:

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

creationTime

public Instant creationTime()

The time that the task was created.

Returns:

The time that the task was created.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeTaskResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeTaskResponse.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.