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

static interface DescribeTaskResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeTaskResponse.Builder`	`builder()`
`String`	`cloudWatchLogGroupArn()`	The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
`Instant`	`creationTime()`	The time that the task was created.
`String`	`currentTaskExecutionArn()`	The ARN of the most recent task execution.
`String`	`destinationLocationArn()`	The ARN of your transfer's destination location.
`List<String>`	`destinationNetworkInterfaceArns()`	The ARNs of the network interfaces that DataSync created for your destination location.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorCode()`	If there's an issue with your task, you can use the error code to help you troubleshoot the problem.
`String`	`errorDetail()`	If there's an issue with your task, you can use the error details to help you troubleshoot the problem.
`List<FilterRule>`	`excludes()`	The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestinationNetworkInterfaceArns()`	For responses, this returns true if the service returned a value for the DestinationNetworkInterfaceArns property.
`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.
`boolean`	`hasSourceNetworkInterfaceArns()`	For responses, this returns true if the service returned a value for the SourceNetworkInterfaceArns property.
`List<FilterRule>`	`includes()`	The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
`ManifestConfig`	`manifestConfig()`	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
`String`	`name()`	The name of your task.
`Options`	`options()`	The task's settings.
`TaskSchedule`	`schedule()`	The schedule for when you want your task to run.
`TaskScheduleDetails`	`scheduleDetails()`	The details about your task schedule.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeTaskResponse.Builder>`	`serializableBuilderClass()`
`String`	`sourceLocationArn()`	The ARN of your transfer's source location.
`List<String>`	`sourceNetworkInterfaceArns()`	The ARNs of the network interfaces that DataSync created for your source location.
`TaskStatus`	`status()`	The status of your task.
`String`	`statusAsString()`	The status of your task.
`String`	`taskArn()`	The ARN of your task.
`TaskReportConfig`	`taskReportConfig()`	The configuration of your task report, which provides detailed information about your DataSync transfer.
`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 final String taskArn()
```
    The ARN of your task.
    
    Returns:
    
    The ARN of your task.
  - status
```
public final TaskStatus status()
```
    The status of your task. For information about what each status means, see 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 your task. For information about what each status means, see Task statuses.
    
    See Also:
    
    TaskStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of your task. For information about what each status means, see 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 your task. For information about what each status means, see Task statuses.
    
    See Also:
    
    TaskStatus
  - name
```
public final String name()
```
    The name of your task.
    
    Returns:
    
    The name of your task.
  - currentTaskExecutionArn
```
public final String currentTaskExecutionArn()
```
    The ARN of the most recent task execution.
    
    Returns:
    
    The ARN of the most recent task execution.
  - sourceLocationArn
```
public final String sourceLocationArn()
```
    The ARN of your transfer's source location.
    
    Returns:
    
    The ARN of your transfer's source location.
  - destinationLocationArn
```
public final String destinationLocationArn()
```
    The ARN of your transfer's destination location.
    
    Returns:
    
    The ARN of your transfer's destination location.
  - cloudWatchLogGroupArn
```
public final String cloudWatchLogGroupArn()
```
    The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
    
    For more information, see Monitoring DataSync with Amazon CloudWatch.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
    
    For more information, see Monitoring DataSync with Amazon CloudWatch.
  - hasSourceNetworkInterfaceArns
```
public final boolean hasSourceNetworkInterfaceArns()
```
    For responses, this returns true if the service returned a value for the SourceNetworkInterfaceArns 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.
  - sourceNetworkInterfaceArns
```
public final List<String> sourceNetworkInterfaceArns()
```
    The ARNs of the network interfaces that DataSync created for your source location.
    
    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 hasSourceNetworkInterfaceArns() method.
    
    Returns:
    
    The ARNs of the network interfaces that DataSync created for your source location.
  - hasDestinationNetworkInterfaceArns
```
public final boolean hasDestinationNetworkInterfaceArns()
```
    For responses, this returns true if the service returned a value for the DestinationNetworkInterfaceArns 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.
  - destinationNetworkInterfaceArns
```
public final List<String> destinationNetworkInterfaceArns()
```
    The ARNs of the network interfaces that DataSync created for your destination location.
    
    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 hasDestinationNetworkInterfaceArns() method.
    
    Returns:
    
    The ARNs of the network interfaces that DataSync created for your destination location.
  - options
```
public final Options options()
```
    The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.
    
    Returns:
    
    The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.
  - 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()
```
    The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
    
    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:
    
    The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
  - schedule
```
public final TaskSchedule schedule()
```
    The schedule for when you want your task to run. For more information, see Scheduling your task.
    
    Returns:
    
    The schedule for when you want your task to run. For more information, see Scheduling your task.
  - errorCode
```
public final String errorCode()
```
    If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
    
    Returns:
    
    If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
  - errorDetail
```
public final String errorDetail()
```
    If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
    
    Returns:
    
    If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
  - creationTime
```
public final Instant creationTime()
```
    The time that the task was created.
    
    Returns:
    
    The time that the task was created.
  - 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()
```
    The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
    
    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:
    
    The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
  - manifestConfig
```
public final ManifestConfig manifestConfig()
```
    The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
    
    Returns:
    
    The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
  - taskReportConfig
```
public final TaskReportConfig taskReportConfig()
```
    The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
    
    Returns:
    
    The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
  - scheduleDetails
```
public final TaskScheduleDetails scheduleDetails()
```
    The details about your task schedule.
    
    Returns:
    
    The details about your task schedule.
  - toBuilder
```
public DescribeTaskResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeTaskResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeTaskResponse.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 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

hasIncludes

includes

manifestConfig

taskReportConfig

scheduleDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields