@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 an Amazon CloudWatch log group for monitoring your task.
|
Date |
getCreationTime()
The time that the task was created.
|
String |
getCurrentTaskExecutionArn()
The ARN of the most recent task execution.
|
String |
getDestinationLocationArn()
The ARN of your transfer's destination location.
|
List<String> |
getDestinationNetworkInterfaceArns()
The ARNs of the network interfaces that DataSync created for your destination location.
|
String |
getErrorCode()
If there's an issue with your task, you can use the error code to help you troubleshoot the problem.
|
String |
getErrorDetail()
If there's an issue with your task, you can use the error details to help you troubleshoot the problem.
|
List<FilterRule> |
getExcludes()
The exclude filters that define the files, objects, and folders in your source location that you don't want
DataSync to transfer.
|
List<FilterRule> |
getIncludes()
The include filters that define the files, objects, and folders in your source location that you want DataSync to
transfer.
|
ManifestConfig |
getManifestConfig()
The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
|
String |
getName()
The name of your task.
|
Options |
getOptions()
The task's settings.
|
TaskSchedule |
getSchedule()
The schedule for when you want your task to run.
|
TaskScheduleDetails |
getScheduleDetails()
The details about your task
schedule.
|
String |
getSourceLocationArn()
The ARN of your transfer's source location.
|
List<String> |
getSourceNetworkInterfaceArns()
The ARNs of the network interfaces that DataSync created for your source location.
|
String |
getStatus()
The status of your task.
|
String |
getTaskArn()
The ARN of your task.
|
TaskReportConfig |
getTaskReportConfig()
The configuration of your task report, which provides detailed information about your DataSync transfer.
|
int |
hashCode() |
void |
setCloudWatchLogGroupArn(String cloudWatchLogGroupArn)
The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
|
void |
setCreationTime(Date creationTime)
The time that the task was created.
|
void |
setCurrentTaskExecutionArn(String currentTaskExecutionArn)
The ARN of the most recent task execution.
|
void |
setDestinationLocationArn(String destinationLocationArn)
The ARN of your transfer's destination location.
|
void |
setDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your destination location.
|
void |
setErrorCode(String errorCode)
If there's an issue with your task, you can use the error code to help you troubleshoot the problem.
|
void |
setErrorDetail(String errorDetail)
If there's an issue with your task, you can use the error details to help you troubleshoot the problem.
|
void |
setExcludes(Collection<FilterRule> excludes)
The exclude filters that define the files, objects, and folders in your source location that you don't want
DataSync to transfer.
|
void |
setIncludes(Collection<FilterRule> includes)
The include filters that define the files, objects, and folders in your source location that you want DataSync to
transfer.
|
void |
setManifestConfig(ManifestConfig manifestConfig)
The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
|
void |
setName(String name)
The name of your task.
|
void |
setOptions(Options options)
The task's settings.
|
void |
setSchedule(TaskSchedule schedule)
The schedule for when you want your task to run.
|
void |
setScheduleDetails(TaskScheduleDetails scheduleDetails)
The details about your task
schedule.
|
void |
setSourceLocationArn(String sourceLocationArn)
The ARN of your transfer's source location.
|
void |
setSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your source location.
|
void |
setStatus(String status)
The status of your task.
|
void |
setTaskArn(String taskArn)
The ARN of your task.
|
void |
setTaskReportConfig(TaskReportConfig taskReportConfig)
The configuration of your task report, which provides detailed information about your DataSync transfer.
|
String |
toString()
Returns a string representation of this object.
|
DescribeTaskResult |
withCloudWatchLogGroupArn(String cloudWatchLogGroupArn)
The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
|
DescribeTaskResult |
withCreationTime(Date creationTime)
The time that the task was created.
|
DescribeTaskResult |
withCurrentTaskExecutionArn(String currentTaskExecutionArn)
The ARN of the most recent task execution.
|
DescribeTaskResult |
withDestinationLocationArn(String destinationLocationArn)
The ARN of your transfer's destination location.
|
DescribeTaskResult |
withDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your destination location.
|
DescribeTaskResult |
withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your destination location.
|
DescribeTaskResult |
withErrorCode(String errorCode)
If there's an issue with your task, you can use the error code to help you troubleshoot the problem.
|
DescribeTaskResult |
withErrorDetail(String errorDetail)
If there's an issue with your task, you can use the error details to help you troubleshoot the problem.
|
DescribeTaskResult |
withExcludes(Collection<FilterRule> excludes)
The exclude filters that define the files, objects, and folders in your source location that you don't want
DataSync to transfer.
|
DescribeTaskResult |
withExcludes(FilterRule... excludes)
The exclude filters that define the files, objects, and folders in your source location that you don't want
DataSync to transfer.
|
DescribeTaskResult |
withIncludes(Collection<FilterRule> includes)
The include filters that define the files, objects, and folders in your source location that you want DataSync to
transfer.
|
DescribeTaskResult |
withIncludes(FilterRule... includes)
The include filters that define the files, objects, and folders in your source location that you want DataSync to
transfer.
|
DescribeTaskResult |
withManifestConfig(ManifestConfig manifestConfig)
The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
|
DescribeTaskResult |
withName(String name)
The name of your task.
|
DescribeTaskResult |
withOptions(Options options)
The task's settings.
|
DescribeTaskResult |
withSchedule(TaskSchedule schedule)
The schedule for when you want your task to run.
|
DescribeTaskResult |
withScheduleDetails(TaskScheduleDetails scheduleDetails)
The details about your task
schedule.
|
DescribeTaskResult |
withSourceLocationArn(String sourceLocationArn)
The ARN of your transfer's source location.
|
DescribeTaskResult |
withSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your source location.
|
DescribeTaskResult |
withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your source location.
|
DescribeTaskResult |
withStatus(String status)
The status of your task.
|
DescribeTaskResult |
withStatus(TaskStatus status)
The status of your task.
|
DescribeTaskResult |
withTaskArn(String taskArn)
The ARN of your task.
|
DescribeTaskResult |
withTaskReportConfig(TaskReportConfig taskReportConfig)
The configuration of your task report, which provides detailed information about your DataSync transfer.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setTaskArn(String taskArn)
The ARN of your task.
taskArn
- The ARN of your task.public String getTaskArn()
The ARN of your task.
public DescribeTaskResult withTaskArn(String taskArn)
The ARN of your task.
taskArn
- The ARN of your task.public void setStatus(String status)
The status of your task. For information about what each status means, see Task statuses.
status
- The status of your task. For information about what each status means, see Task statuses.TaskStatus
public String getStatus()
The status of your task. For information about what each status means, see Task statuses.
TaskStatus
public DescribeTaskResult withStatus(String status)
The status of your task. For information about what each status means, see Task statuses.
status
- The status of your task. For information about what each status means, see Task statuses.TaskStatus
public DescribeTaskResult withStatus(TaskStatus status)
The status of your task. For information about what each status means, see Task statuses.
status
- The status of your task. For information about what each status means, see Task statuses.TaskStatus
public void setName(String name)
The name of your task.
name
- The name of your task.public String getName()
The name of your task.
public DescribeTaskResult withName(String name)
The name of your task.
name
- The name of your task.public void setCurrentTaskExecutionArn(String currentTaskExecutionArn)
The ARN of the most recent task execution.
currentTaskExecutionArn
- The ARN of the most recent task execution.public String getCurrentTaskExecutionArn()
The ARN of the most recent task execution.
public DescribeTaskResult withCurrentTaskExecutionArn(String currentTaskExecutionArn)
The ARN of the most recent task execution.
currentTaskExecutionArn
- The ARN of the most recent task execution.public void setSourceLocationArn(String sourceLocationArn)
The ARN of your transfer's source location.
sourceLocationArn
- The ARN of your transfer's source location.public String getSourceLocationArn()
The ARN of your transfer's source location.
public DescribeTaskResult withSourceLocationArn(String sourceLocationArn)
The ARN of your transfer's source location.
sourceLocationArn
- The ARN of your transfer's source location.public void setDestinationLocationArn(String destinationLocationArn)
The ARN of your transfer's destination location.
destinationLocationArn
- The ARN of your transfer's destination location.public String getDestinationLocationArn()
The ARN of your transfer's destination location.
public DescribeTaskResult withDestinationLocationArn(String destinationLocationArn)
The ARN of your transfer's destination location.
destinationLocationArn
- The ARN of your transfer's destination location.public void setCloudWatchLogGroupArn(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.
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.
public String getCloudWatchLogGroupArn()
The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For more information, see Monitoring DataSync with Amazon CloudWatch.
For more information, see Monitoring DataSync with Amazon CloudWatch.
public DescribeTaskResult withCloudWatchLogGroupArn(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.
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.
public List<String> getSourceNetworkInterfaceArns()
The ARNs of the network interfaces that DataSync created for your source location.
public void setSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your source location.
sourceNetworkInterfaceArns
- The ARNs of the network interfaces that DataSync created for your source location.public DescribeTaskResult withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your source location.
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 ARNs of the network interfaces that DataSync created for your source location.public DescribeTaskResult withSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your source location.
sourceNetworkInterfaceArns
- The ARNs of the network interfaces that DataSync created for your source location.public List<String> getDestinationNetworkInterfaceArns()
The ARNs of the network interfaces that DataSync created for your destination location.
public void setDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your destination location.
destinationNetworkInterfaceArns
- The ARNs of the network interfaces that DataSync created for your destination location.public DescribeTaskResult withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your destination location.
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 ARNs of the network interfaces that DataSync created for your destination location.public DescribeTaskResult withDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The ARNs of the network interfaces that DataSync created for your destination location.
destinationNetworkInterfaceArns
- The ARNs of the network interfaces that DataSync created for your destination location.public void setOptions(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.
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.public Options getOptions()
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.
public DescribeTaskResult withOptions(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.
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.public List<FilterRule> getExcludes()
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.
public void setExcludes(Collection<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.
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.public DescribeTaskResult withExcludes(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.
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
- 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.public DescribeTaskResult withExcludes(Collection<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.
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.public void setSchedule(TaskSchedule schedule)
The schedule for when you want your task to run. For more information, see Scheduling your task.
schedule
- The schedule for when you want your task to run. For more information, see Scheduling your
task.public TaskSchedule getSchedule()
The schedule for when you want your task to run. For more information, see Scheduling your task.
public DescribeTaskResult withSchedule(TaskSchedule schedule)
The schedule for when you want your task to run. For more information, see Scheduling your task.
schedule
- The schedule for when you want your task to run. For more information, see Scheduling your
task.public void setErrorCode(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.
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.public String getErrorCode()
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.
public DescribeTaskResult withErrorCode(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.
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.public void setErrorDetail(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.
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.public String getErrorDetail()
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.
public DescribeTaskResult withErrorDetail(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.
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.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()
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.
public void setIncludes(Collection<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.
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.public DescribeTaskResult withIncludes(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.
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
- 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.public DescribeTaskResult withIncludes(Collection<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.
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.public void setManifestConfig(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.
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.public ManifestConfig getManifestConfig()
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.
public DescribeTaskResult withManifestConfig(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.
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.public void setTaskReportConfig(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.
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.public TaskReportConfig getTaskReportConfig()
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.
public DescribeTaskResult withTaskReportConfig(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.
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.public void setScheduleDetails(TaskScheduleDetails scheduleDetails)
The details about your task schedule.
scheduleDetails
- The details about your task schedule.public TaskScheduleDetails getScheduleDetails()
The details about your task schedule.
public DescribeTaskResult withScheduleDetails(TaskScheduleDetails scheduleDetails)
The details about your task schedule.
scheduleDetails
- The details about your task schedule.public String toString()
toString
in class Object
Object.toString()
public DescribeTaskResult clone()