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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`List<String>`	`destinationNetworkInterfaceArns()` The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(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.
`List<FilterRule>`	`excludes()` A list of filter rules that determines which files to exclude from a task.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestinationNetworkInterfaceArns()` Returns true if the DestinationNetworkInterfaceArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasExcludes()` Returns true if the Excludes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSourceNetworkInterfaceArns()` Returns true if the SourceNetworkInterfaceArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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`.
`TaskSchedule`	`schedule()` The schedule used to periodically transfer files from a source to a destination location.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeTaskResponse.Builder>`	`serializableBuilderClass()`
`String`	`sourceLocationArn()` The Amazon Resource Name (ARN) of the source file system's location.
`List<String>`	`sourceNetworkInterfaceArns()` The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.
`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()`
`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
  - 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 task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.
    
    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 task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.
    
    See Also:
    
    TaskStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the task that was described.
    
    For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.
    
    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 task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.
    
    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.
  - hasSourceNetworkInterfaceArns
```
public boolean hasSourceNetworkInterfaceArns()
```
    Returns true if the SourceNetworkInterfaceArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - sourceNetworkInterfaceArns
```
public List<String> sourceNetworkInterfaceArns()
```
    The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSourceNetworkInterfaceArns() to see if a value was sent in this field.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.
  - hasDestinationNetworkInterfaceArns
```
public boolean hasDestinationNetworkInterfaceArns()
```
    Returns true if the DestinationNetworkInterfaceArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - destinationNetworkInterfaceArns
```
public List<String> destinationNetworkInterfaceArns()
```
    The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDestinationNetworkInterfaceArns() to see if a value was sent in this field.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.
  - 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.
  - hasExcludes
```
public boolean hasExcludes()
```
    Returns true if the Excludes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - excludes
```
public 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.
    
    You can use hasExcludes() to see if a value was sent in this field.
    
    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"
  - schedule
```
public TaskSchedule schedule()
```
    The schedule used to periodically transfer files from a source to a destination location.
    
    Returns:
    
    The schedule used to periodically transfer files from a source to a destination location.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeTaskResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeTaskResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeTaskResponse

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

taskArn

status

statusAsString

name

currentTaskExecutionArn

sourceLocationArn

destinationLocationArn

cloudWatchLogGroupArn

hasSourceNetworkInterfaceArns

sourceNetworkInterfaceArns

hasDestinationNetworkInterfaceArns

destinationNetworkInterfaceArns

options

hasExcludes

excludes

schedule

errorCode

errorDetail

creationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields