DescribeTaskResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.datasync.model.DescribeTaskResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeTaskResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

DescribeTaskResponse

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeTaskResult()

Constructors
Constructor and Description
`DescribeTaskResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeTaskResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCloudWatchLogGroupArn()` The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
`Date`	`getCreationTime()` The time that the task was created.
`String`	`getCurrentTaskExecutionArn()` The Amazon Resource Name (ARN) of the task execution that is syncing files.
`String`	`getDestinationLocationArn()` The Amazon Resource Name (ARN) of the AWS storage resource's location.
`String`	`getErrorCode()` Errors that AWS DataSync encountered during execution of the task.
`String`	`getErrorDetail()` Detailed description of an error that was encountered during the task execution.
`List<FilterRule>`	`getExcludes()`
`String`	`getName()` The name of the task that was described.
`Options`	`getOptions()` The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution`.
`String`	`getSourceLocationArn()` The Amazon Resource Name (ARN) of the source file system's location.
`String`	`getStatus()` The status of the task that was described.
`String`	`getTaskArn()` The Amazon Resource Name (ARN) of the task that was described.
`int`	`hashCode()`
`void`	`setCloudWatchLogGroupArn(String cloudWatchLogGroupArn)` The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
`void`	`setCreationTime(Date creationTime)` The time that the task was created.
`void`	`setCurrentTaskExecutionArn(String currentTaskExecutionArn)` The Amazon Resource Name (ARN) of the task execution that is syncing files.
`void`	`setDestinationLocationArn(String destinationLocationArn)` The Amazon Resource Name (ARN) of the AWS storage resource's location.
`void`	`setErrorCode(String errorCode)` Errors that AWS DataSync encountered during execution of the task.
`void`	`setErrorDetail(String errorDetail)` Detailed description of an error that was encountered during the task execution.
`void`	`setExcludes(Collection<FilterRule> excludes)`
`void`	`setName(String name)` The name of the task that was described.
`void`	`setOptions(Options options)` The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution`.
`void`	`setSourceLocationArn(String sourceLocationArn)` The Amazon Resource Name (ARN) of the source file system's location.
`void`	`setStatus(String status)` The status of the task that was described.
`void`	`setTaskArn(String taskArn)` The Amazon Resource Name (ARN) of the task that was described.
`String`	`toString()` Returns a string representation of this object.
`DescribeTaskResult`	`withCloudWatchLogGroupArn(String cloudWatchLogGroupArn)` The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
`DescribeTaskResult`	`withCreationTime(Date creationTime)` The time that the task was created.
`DescribeTaskResult`	`withCurrentTaskExecutionArn(String currentTaskExecutionArn)` The Amazon Resource Name (ARN) of the task execution that is syncing files.
`DescribeTaskResult`	`withDestinationLocationArn(String destinationLocationArn)` The Amazon Resource Name (ARN) of the AWS storage resource's location.
`DescribeTaskResult`	`withErrorCode(String errorCode)` Errors that AWS DataSync encountered during execution of the task.
`DescribeTaskResult`	`withErrorDetail(String errorDetail)` Detailed description of an error that was encountered during the task execution.
`DescribeTaskResult`	`withExcludes(Collection<FilterRule> excludes)`
`DescribeTaskResult`	`withExcludes(FilterRule... excludes)`
`DescribeTaskResult`	`withName(String name)` The name of the task that was described.
`DescribeTaskResult`	`withOptions(Options options)` The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution`.
`DescribeTaskResult`	`withSourceLocationArn(String sourceLocationArn)` The Amazon Resource Name (ARN) of the source file system's location.
`DescribeTaskResult`	`withStatus(String status)` The status of the task that was described.
`DescribeTaskResult`	`withStatus(TaskStatus status)` The status of the task that was described.
`DescribeTaskResult`	`withTaskArn(String taskArn)` The Amazon Resource Name (ARN) of the task that was described.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeTaskResult
```
public DescribeTaskResult()
```
- Method Detail
  - setTaskArn
```
public void setTaskArn(String taskArn)
```
    The Amazon Resource Name (ARN) of the task that was described.
    
    Parameters:
    
    taskArn - The Amazon Resource Name (ARN) of the task that was described.
  - getTaskArn
```
public String getTaskArn()
```
    The Amazon Resource Name (ARN) of the task that was described.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task that was described.
  - withTaskArn
```
public DescribeTaskResult withTaskArn(String taskArn)
```
    The Amazon Resource Name (ARN) of the task that was described.
    
    Parameters:
    
    taskArn - The Amazon Resource Name (ARN) of the task that was described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    Parameters:
    
    status - The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    See Also:
    
    TaskStatus
  - getStatus
```
public String getStatus()
```
    The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    Returns:
    
    The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    See Also:
    
    TaskStatus
  - withStatus
```
public DescribeTaskResult withStatus(String status)
```
    The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    Parameters:
    
    status - The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskStatus
  - withStatus
```
public DescribeTaskResult withStatus(TaskStatus status)
```
    The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    Parameters:
    
    status - The status of the task that was described.
    
    For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskStatus
  - setName
```
public void setName(String name)
```
    The name of the task that was described.
    
    Parameters:
    
    name - The name of the task that was described.
  - getName
```
public String getName()
```
    The name of the task that was described.
    
    Returns:
    
    The name of the task that was described.
  - withName
```
public DescribeTaskResult withName(String name)
```
    The name of the task that was described.
    
    Parameters:
    
    name - The name of the task that was described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentTaskExecutionArn
```
public void setCurrentTaskExecutionArn(String currentTaskExecutionArn)
```
    The Amazon Resource Name (ARN) of the task execution that is syncing files.
    
    Parameters:
    
    currentTaskExecutionArn - The Amazon Resource Name (ARN) of the task execution that is syncing files.
  - getCurrentTaskExecutionArn
```
public String getCurrentTaskExecutionArn()
```
    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.
  - withCurrentTaskExecutionArn
```
public DescribeTaskResult withCurrentTaskExecutionArn(String currentTaskExecutionArn)
```
    The Amazon Resource Name (ARN) of the task execution that is syncing files.
    
    Parameters:
    
    currentTaskExecutionArn - The Amazon Resource Name (ARN) of the task execution that is syncing files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceLocationArn
```
public void setSourceLocationArn(String sourceLocationArn)
```
    The Amazon Resource Name (ARN) of the source file system's location.
    
    Parameters:
    
    sourceLocationArn - The Amazon Resource Name (ARN) of the source file system's location.
  - getSourceLocationArn
```
public String getSourceLocationArn()
```
    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.
  - withSourceLocationArn
```
public DescribeTaskResult withSourceLocationArn(String sourceLocationArn)
```
    The Amazon Resource Name (ARN) of the source file system's location.
    
    Parameters:
    
    sourceLocationArn - The Amazon Resource Name (ARN) of the source file system's location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationLocationArn
```
public void setDestinationLocationArn(String destinationLocationArn)
```
    The Amazon Resource Name (ARN) of the AWS storage resource's location.
    
    Parameters:
    
    destinationLocationArn - The Amazon Resource Name (ARN) of the AWS storage resource's location.
  - getDestinationLocationArn
```
public String getDestinationLocationArn()
```
    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.
  - withDestinationLocationArn
```
public DescribeTaskResult withDestinationLocationArn(String destinationLocationArn)
```
    The Amazon Resource Name (ARN) of the AWS storage resource's location.
    
    Parameters:
    
    destinationLocationArn - The Amazon Resource Name (ARN) of the AWS storage resource's location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLogGroupArn
```
public void setCloudWatchLogGroupArn(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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
    
    Parameters:
    
    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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
  - getCloudWatchLogGroupArn
```
public String getCloudWatchLogGroupArn()
```
    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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
    
    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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
  - withCloudWatchLogGroupArn
```
public DescribeTaskResult withCloudWatchLogGroupArn(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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
    
    Parameters:
    
    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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOptions
```
public void setOptions(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.
    
    Parameters:
    
    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.
  - getOptions
```
public Options getOptions()
```
    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.
  - withOptions
```
public DescribeTaskResult withOptions(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludes
```
public List<FilterRule> getExcludes()
```
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    
    Returns:
    
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
  - setExcludes
```
public void setExcludes(Collection<FilterRule> excludes)
```
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    
    Parameters:
    
    excludes -
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
  - withExcludes
```
public DescribeTaskResult withExcludes(FilterRule... excludes)
```
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludes(java.util.Collection) or withExcludes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    excludes -
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludes
```
public DescribeTaskResult withExcludes(Collection<FilterRule> excludes)
```
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    
    Parameters:
    
    excludes -
    Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
    
    Parameters:
    
    errorCode - Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
  - getErrorCode
```
public String getErrorCode()
```
    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.
  - withErrorCode
```
public DescribeTaskResult withErrorCode(String errorCode)
```
    Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
    
    Parameters:
    
    errorCode - Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorDetail
```
public void setErrorDetail(String errorDetail)
```
    Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
    
    Parameters:
    
    errorDetail - Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
  - getErrorDetail
```
public String getErrorDetail()
```
    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.
  - withErrorDetail
```
public DescribeTaskResult withErrorDetail(String errorDetail)
```
    Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
    
    Parameters:
    
    errorDetail - Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time that the task was created.
    
    Parameters:
    
    creationTime - The time that the task was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time that the task was created.
    
    Returns:
    
    The time that the task was created.
  - withCreationTime
```
public DescribeTaskResult withCreationTime(Date creationTime)
```
    The time that the task was created.
    
    Parameters:
    
    creationTime - The time that the task was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeTaskResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeTaskResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeTaskResult

Method Detail

setTaskArn

getTaskArn

withTaskArn

setStatus

getStatus

withStatus

withStatus

setName

getName

withName

setCurrentTaskExecutionArn

getCurrentTaskExecutionArn

withCurrentTaskExecutionArn

setSourceLocationArn

getSourceLocationArn

withSourceLocationArn

setDestinationLocationArn

getDestinationLocationArn

withDestinationLocationArn

setCloudWatchLogGroupArn

getCloudWatchLogGroupArn

withCloudWatchLogGroupArn

setOptions

getOptions

withOptions

getExcludes

setExcludes

withExcludes

withExcludes

setErrorCode

getErrorCode

withErrorCode

setErrorDetail

getErrorDetail

withErrorDetail

setCreationTime

getCreationTime

withCreationTime

toString

equals

hashCode

clone