@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
DescribeTaskResponse
Constructor and Description |
---|
DescribeTaskResult() |
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 transferring files.
|
String |
getDestinationLocationArn()
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
|
List<String> |
getDestinationNetworkInterfaceArns()
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.
|
String |
getErrorCode()
Errors that DataSync encountered during execution of the task.
|
String |
getErrorDetail()
Detailed description of an error that was encountered during the task execution.
|
List<FilterRule> |
getExcludes()
A list of filter rules that exclude specific data during your transfer.
|
List<FilterRule> |
getIncludes()
A list of filter rules that include specific data during your transfer.
|
String |
getName()
The name of the task that was described.
|
Options |
getOptions()
The configuration options that control the behavior of the
StartTaskExecution operation. |
TaskSchedule |
getSchedule()
The schedule used to periodically transfer files from a source to a destination location.
|
String |
getSourceLocationArn()
The Amazon Resource Name (ARN) of the source file system's location.
|
List<String> |
getSourceNetworkInterfaceArns()
The Amazon Resource Names (ARNs) of the network interfaces created for your source location.
|
String |
getStatus()
The status of the task that was described.
|
String |
getTaskArn()
The Amazon Resource Name (ARN) of the task that was described.
|
TaskReportConfig |
getTaskReportConfig()
The configuration of your task report.
|
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 transferring files.
|
void |
setDestinationLocationArn(String destinationLocationArn)
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
|
void |
setDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.
|
void |
setErrorCode(String errorCode)
Errors that 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)
A list of filter rules that exclude specific data during your transfer.
|
void |
setIncludes(Collection<FilterRule> includes)
A list of filter rules that include specific data during your transfer.
|
void |
setName(String name)
The name of the task that was described.
|
void |
setOptions(Options options)
The configuration options that control the behavior of the
StartTaskExecution operation. |
void |
setSchedule(TaskSchedule schedule)
The schedule used to periodically transfer files from a source to a destination location.
|
void |
setSourceLocationArn(String sourceLocationArn)
The Amazon Resource Name (ARN) of the source file system's location.
|
void |
setSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your source 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.
|
void |
setTaskReportConfig(TaskReportConfig taskReportConfig)
The configuration of your task report.
|
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 transferring files.
|
DescribeTaskResult |
withDestinationLocationArn(String destinationLocationArn)
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
|
DescribeTaskResult |
withDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.
|
DescribeTaskResult |
withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.
|
DescribeTaskResult |
withErrorCode(String errorCode)
Errors that 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)
A list of filter rules that exclude specific data during your transfer.
|
DescribeTaskResult |
withExcludes(FilterRule... excludes)
A list of filter rules that exclude specific data during your transfer.
|
DescribeTaskResult |
withIncludes(Collection<FilterRule> includes)
A list of filter rules that include specific data during your transfer.
|
DescribeTaskResult |
withIncludes(FilterRule... includes)
A list of filter rules that include specific data during your transfer.
|
DescribeTaskResult |
withName(String name)
The name of the task that was described.
|
DescribeTaskResult |
withOptions(Options options)
The configuration options that control the behavior of the
StartTaskExecution operation. |
DescribeTaskResult |
withSchedule(TaskSchedule schedule)
The schedule used to periodically transfer files from a source to a destination location.
|
DescribeTaskResult |
withSourceLocationArn(String sourceLocationArn)
The Amazon Resource Name (ARN) of the source file system's location.
|
DescribeTaskResult |
withSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your source location.
|
DescribeTaskResult |
withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your source 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.
|
DescribeTaskResult |
withTaskReportConfig(TaskReportConfig taskReportConfig)
The configuration of your task report.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the task that was described.
taskArn
- The Amazon Resource Name (ARN) of the task that was described.public String getTaskArn()
The Amazon Resource Name (ARN) of the task that was described.
public DescribeTaskResult withTaskArn(String taskArn)
The Amazon Resource Name (ARN) of the task that was described.
taskArn
- The Amazon Resource Name (ARN) of the task that was described.public void setStatus(String status)
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
status
- The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskStatus
public String getStatus()
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskStatus
public DescribeTaskResult withStatus(String status)
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
status
- The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskStatus
public DescribeTaskResult withStatus(TaskStatus status)
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
status
- The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskStatus
public void setName(String name)
The name of the task that was described.
name
- The name of the task that was described.public String getName()
The name of the task that was described.
public DescribeTaskResult withName(String name)
The name of the task that was described.
name
- The name of the task that was described.public void setCurrentTaskExecutionArn(String currentTaskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that is transferring files.
currentTaskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that is transferring files.public String getCurrentTaskExecutionArn()
The Amazon Resource Name (ARN) of the task execution that is transferring files.
public DescribeTaskResult withCurrentTaskExecutionArn(String currentTaskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that is transferring files.
currentTaskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that is transferring files.public void setSourceLocationArn(String sourceLocationArn)
The Amazon Resource Name (ARN) of the source file system's location.
sourceLocationArn
- The Amazon Resource Name (ARN) of the source file system's location.public String getSourceLocationArn()
The Amazon Resource Name (ARN) of the source file system's location.
public DescribeTaskResult withSourceLocationArn(String sourceLocationArn)
The Amazon Resource Name (ARN) of the source file system's location.
sourceLocationArn
- The Amazon Resource Name (ARN) of the source file system's location.public void setDestinationLocationArn(String destinationLocationArn)
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
destinationLocationArn
- The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.public String getDestinationLocationArn()
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
public DescribeTaskResult withDestinationLocationArn(String destinationLocationArn)
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
destinationLocationArn
- The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.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 Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
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.
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 Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
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 Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
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.
public List<String> getSourceNetworkInterfaceArns()
The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.
public void setSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.
sourceNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more
information, see Network interface requirements.public DescribeTaskResult withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.
NOTE: This method appends the values to the existing list (if any). Use
setSourceNetworkInterfaceArns(java.util.Collection)
or
withSourceNetworkInterfaceArns(java.util.Collection)
if you want to override the existing values.
sourceNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more
information, see Network interface requirements.public DescribeTaskResult withSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.
sourceNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more
information, see Network interface requirements.public List<String> getDestinationNetworkInterfaceArns()
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.
public void setDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.
destinationNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more
information, see Network interface requirements.public DescribeTaskResult withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.
NOTE: This method appends the values to the existing list (if any). Use
setDestinationNetworkInterfaceArns(java.util.Collection)
or
withDestinationNetworkInterfaceArns(java.util.Collection)
if you want to override the existing values.
destinationNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more
information, see Network interface requirements.public DescribeTaskResult withDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.
destinationNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more
information, see Network interface requirements.public void setOptions(Options options)
The configuration options that control the behavior of the StartTaskExecution
operation. Some
options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
options
- The configuration options that control the behavior of the StartTaskExecution
operation. Some
options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
public Options getOptions()
The configuration options that control the behavior of the StartTaskExecution
operation. Some
options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
StartTaskExecution
operation.
Some options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
public DescribeTaskResult withOptions(Options options)
The configuration options that control the behavior of the StartTaskExecution
operation. Some
options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
options
- The configuration options that control the behavior of the StartTaskExecution
operation. Some
options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
public List<FilterRule> getExcludes()
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
public void setExcludes(Collection<FilterRule> excludes)
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
excludes
- A list of filter rules that exclude specific data during your transfer. For more information and examples,
see Filtering data
transferred by DataSync.public DescribeTaskResult withExcludes(FilterRule... excludes)
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
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.
excludes
- A list of filter rules that exclude specific data during your transfer. For more information and examples,
see Filtering data
transferred by DataSync.public DescribeTaskResult withExcludes(Collection<FilterRule> excludes)
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
excludes
- A list of filter rules that exclude specific data during your transfer. For more information and examples,
see Filtering data
transferred by DataSync.public void setSchedule(TaskSchedule schedule)
The schedule used to periodically transfer files from a source to a destination location.
schedule
- The schedule used to periodically transfer files from a source to a destination location.public TaskSchedule getSchedule()
The schedule used to periodically transfer files from a source to a destination location.
public DescribeTaskResult withSchedule(TaskSchedule schedule)
The schedule used to periodically transfer files from a source to a destination location.
schedule
- The schedule used to periodically transfer files from a source to a destination location.public void setErrorCode(String errorCode)
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
errorCode
- Errors that DataSync encountered during execution of the task. You can use this error code to help
troubleshoot issues.public String getErrorCode()
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
public DescribeTaskResult withErrorCode(String errorCode)
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
errorCode
- Errors that DataSync encountered during execution of the task. You can use this error code to help
troubleshoot issues.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.
errorDetail
- Detailed description of an error that was encountered during the task execution. You can use this
information to help troubleshoot issues.public String getErrorDetail()
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
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.
errorDetail
- Detailed description of an error that was encountered during the task execution. You can use this
information to help troubleshoot issues.public void setCreationTime(Date creationTime)
The time that the task was created.
creationTime
- The time that the task was created.public Date getCreationTime()
The time that the task was created.
public DescribeTaskResult withCreationTime(Date creationTime)
The time that the task was created.
creationTime
- The time that the task was created.public List<FilterRule> getIncludes()
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
public void setIncludes(Collection<FilterRule> includes)
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
includes
- A list of filter rules that include specific data during your transfer. For more information and examples,
see Filtering data
transferred by DataSync.public DescribeTaskResult withIncludes(FilterRule... includes)
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
NOTE: This method appends the values to the existing list (if any). Use
setIncludes(java.util.Collection)
or withIncludes(java.util.Collection)
if you want to override
the existing values.
includes
- A list of filter rules that include specific data during your transfer. For more information and examples,
see Filtering data
transferred by DataSync.public DescribeTaskResult withIncludes(Collection<FilterRule> includes)
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
includes
- A list of filter rules that include specific data during your transfer. For more information and examples,
see Filtering data
transferred by DataSync.public void setTaskReportConfig(TaskReportConfig taskReportConfig)
The configuration of your task report. For more information, see Creating a task report.
taskReportConfig
- The configuration of your task report. For more information, see Creating a task report.public TaskReportConfig getTaskReportConfig()
The configuration of your task report. For more information, see Creating a task report.
public DescribeTaskResult withTaskReportConfig(TaskReportConfig taskReportConfig)
The configuration of your task report. For more information, see Creating a task report.
taskReportConfig
- The configuration of your task report. For more information, see Creating a task report.public String toString()
toString
in class Object
Object.toString()
public DescribeTaskResult clone()