/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.datasync.model; import java.io.Serializable; import javax.annotation.Generated; /** *
* DescribeTaskResponse *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeTaskResult extends com.amazonaws.AmazonWebServiceResult* The Amazon Resource Name (ARN) of the task that was described. *
*/ private String taskArn; /** ** The status of the task that was described. *
** For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User * Guide. *
*/ private String status; /** ** The name of the task that was described. *
*/ private String name; /** ** The Amazon Resource Name (ARN) of the task execution that is transferring files. *
*/ private String currentTaskExecutionArn; /** ** The Amazon Resource Name (ARN) of the source file system's location. *
*/ private String sourceLocationArn; /** ** The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. *
*/ private String destinationLocationArn; /** ** 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. *
*/ private String cloudWatchLogGroupArn; /** ** The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. *
*/ private java.util.List* The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. *
*/ private java.util.List
* 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. *
*/ private Options options; /** ** A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
*/ private java.util.List* The schedule used to periodically transfer files from a source to a destination location. *
*/ private TaskSchedule schedule; /** ** Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot * issues. *
*/ private String errorCode; /** ** Detailed description of an error that was encountered during the task execution. You can use this information to * help troubleshoot issues. *
*/ private String errorDetail; /** ** The time that the task was created. *
*/ private java.util.Date creationTime; /** ** A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
*/ private java.util.List* The Amazon Resource Name (ARN) of the task that was described. *
* * @param taskArn * The Amazon Resource Name (ARN) of the task that was described. */ public void setTaskArn(String taskArn) { this.taskArn = taskArn; } /** ** The Amazon Resource Name (ARN) of the task that was described. *
* * @return The Amazon Resource Name (ARN) of the task that was described. */ public String getTaskArn() { return this.taskArn; } /** ** The Amazon Resource Name (ARN) of the task that was described. *
* * @param taskArn * The Amazon Resource Name (ARN) of the task that was described. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withTaskArn(String taskArn) { setTaskArn(taskArn); return this; } /** ** The status of the task that was described. *
** For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User * Guide. *
* * @param 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. * @see TaskStatus */ public void setStatus(String status) { this.status = 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. *
* * @return The status of the task that was described. ** For detailed information about task execution statuses, see Understanding Task Statuses in the * DataSync User Guide. * @see TaskStatus */ public String getStatus() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see TaskStatus */ public DescribeTaskResult withStatus(String status) { setStatus(status); return this; } /** *
* The status of the task that was described. *
** For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User * Guide. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see TaskStatus */ public DescribeTaskResult withStatus(TaskStatus status) { this.status = status.toString(); return this; } /** *
* The name of the task that was described. *
* * @param name * The name of the task that was described. */ public void setName(String name) { this.name = name; } /** ** The name of the task that was described. *
* * @return The name of the task that was described. */ public String getName() { return this.name; } /** ** The name of the task that was described. *
* * @param name * The name of the task that was described. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withName(String name) { setName(name); return this; } /** ** The Amazon Resource Name (ARN) of the task execution that is transferring files. *
* * @param currentTaskExecutionArn * The Amazon Resource Name (ARN) of the task execution that is transferring files. */ public void setCurrentTaskExecutionArn(String currentTaskExecutionArn) { this.currentTaskExecutionArn = currentTaskExecutionArn; } /** ** The Amazon Resource Name (ARN) of the task execution that is transferring files. *
* * @return The Amazon Resource Name (ARN) of the task execution that is transferring files. */ public String getCurrentTaskExecutionArn() { return this.currentTaskExecutionArn; } /** ** The Amazon Resource Name (ARN) of the task execution that is transferring files. *
* * @param currentTaskExecutionArn * The Amazon Resource Name (ARN) of the task execution that is transferring files. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withCurrentTaskExecutionArn(String currentTaskExecutionArn) { setCurrentTaskExecutionArn(currentTaskExecutionArn); return this; } /** ** The Amazon Resource Name (ARN) of the source file system's location. *
* * @param sourceLocationArn * The Amazon Resource Name (ARN) of the source file system's location. */ public void setSourceLocationArn(String sourceLocationArn) { this.sourceLocationArn = sourceLocationArn; } /** ** The Amazon Resource Name (ARN) of the source file system's location. *
* * @return The Amazon Resource Name (ARN) of the source file system's location. */ public String getSourceLocationArn() { return this.sourceLocationArn; } /** ** The Amazon Resource Name (ARN) of the source file system's location. *
* * @param sourceLocationArn * The Amazon Resource Name (ARN) of the source file system's location. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withSourceLocationArn(String sourceLocationArn) { setSourceLocationArn(sourceLocationArn); return this; } /** ** The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. *
* * @param destinationLocationArn * The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. */ public void setDestinationLocationArn(String destinationLocationArn) { this.destinationLocationArn = destinationLocationArn; } /** ** The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. *
* * @return The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. */ public String getDestinationLocationArn() { return this.destinationLocationArn; } /** ** The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. *
* * @param destinationLocationArn * The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withDestinationLocationArn(String destinationLocationArn) { setDestinationLocationArn(destinationLocationArn); return this; } /** ** 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. *
* * @param 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 void setCloudWatchLogGroupArn(String cloudWatchLogGroupArn) { this.cloudWatchLogGroupArn = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withCloudWatchLogGroupArn(String cloudWatchLogGroupArn) { setCloudWatchLogGroupArn(cloudWatchLogGroupArn); return this; } /** *
* The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. *
* * @return The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. */ public java.util.List* The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. *
* * @param sourceNetworkInterfaceArns * The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. */ public void setSourceNetworkInterfaceArns(java.util.Collection* 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 * {@link #setSourceNetworkInterfaceArns(java.util.Collection)} or * {@link #withSourceNetworkInterfaceArns(java.util.Collection)} if you want to override the existing values. *
* * @param sourceNetworkInterfaceArns * The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns) { if (this.sourceNetworkInterfaceArns == null) { setSourceNetworkInterfaceArns(new java.util.ArrayList* The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. *
* * @param sourceNetworkInterfaceArns * The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more * information, see Network interface requirements. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withSourceNetworkInterfaceArns(java.util.Collection* The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. *
* * @return The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For * more information, see Network interface requirements. */ public java.util.List* The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. *
* * @param destinationNetworkInterfaceArns * The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. */ public void setDestinationNetworkInterfaceArns(java.util.Collection* 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 * {@link #setDestinationNetworkInterfaceArns(java.util.Collection)} or * {@link #withDestinationNetworkInterfaceArns(java.util.Collection)} if you want to override the existing values. *
* * @param destinationNetworkInterfaceArns * The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns) { if (this.destinationNetworkInterfaceArns == null) { setDestinationNetworkInterfaceArns(new java.util.ArrayList* The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. *
* * @param destinationNetworkInterfaceArns * The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more * information, see Network interface requirements. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withDestinationNetworkInterfaceArns(java.util.Collection
* 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. *
* * @param options * The configuration options that control the behavior of theStartTaskExecution
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 void setOptions(Options options) { this.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. *
* * @return The configuration options that control the behavior of theStartTaskExecution
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() { return this.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. *
* * @param options * The configuration options that control the behavior of theStartTaskExecution
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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withOptions(Options options) { setOptions(options); return this; } /** *
* A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
* * @return A list of filter rules that exclude specific data during your transfer. For more information and * examples, see Filtering * data transferred by DataSync. */ public java.util.List* A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
* * @param 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 setExcludes(java.util.Collection* 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 * {@link #setExcludes(java.util.Collection)} or {@link #withExcludes(java.util.Collection)} if you want to override * the existing values. *
* * @param excludes * A list of filter rules that exclude specific data during your transfer. For more information and examples, * see Filtering data * transferred by DataSync. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withExcludes(FilterRule... excludes) { if (this.excludes == null) { setExcludes(new java.util.ArrayList* A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
* * @param excludes * A list of filter rules that exclude specific data during your transfer. For more information and examples, * see Filtering data * transferred by DataSync. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withExcludes(java.util.Collection* The schedule used to periodically transfer files from a source to a destination location. *
* * @param schedule * The schedule used to periodically transfer files from a source to a destination location. */ public void setSchedule(TaskSchedule schedule) { this.schedule = schedule; } /** ** The schedule used to periodically transfer files from a source to a destination location. *
* * @return The schedule used to periodically transfer files from a source to a destination location. */ public TaskSchedule getSchedule() { return this.schedule; } /** ** The schedule used to periodically transfer files from a source to a destination location. *
* * @param schedule * The schedule used to periodically transfer files from a source to a destination location. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withSchedule(TaskSchedule schedule) { setSchedule(schedule); return this; } /** ** Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot * issues. *
* * @param errorCode * Errors that DataSync encountered during execution of the task. You can use this error code to help * troubleshoot issues. */ public void setErrorCode(String errorCode) { this.errorCode = errorCode; } /** ** Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot * issues. *
* * @return Errors that DataSync encountered during execution of the task. You can use this error code to help * troubleshoot issues. */ public String getErrorCode() { return this.errorCode; } /** ** Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot * issues. *
* * @param errorCode * Errors that DataSync encountered during execution of the task. You can use this error code to help * troubleshoot issues. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withErrorCode(String errorCode) { setErrorCode(errorCode); return this; } /** ** Detailed description of an error that was encountered during the task execution. You can use this information to * help troubleshoot issues. *
* * @param errorDetail * Detailed description of an error that was encountered during the task execution. You can use this * information to help troubleshoot issues. */ public void setErrorDetail(String errorDetail) { this.errorDetail = errorDetail; } /** ** Detailed description of an error that was encountered during the task execution. You can use this information to * help troubleshoot issues. *
* * @return Detailed description of an error that was encountered during the task execution. You can use this * information to help troubleshoot issues. */ public String getErrorDetail() { return this.errorDetail; } /** ** Detailed description of an error that was encountered during the task execution. You can use this information to * help troubleshoot issues. *
* * @param errorDetail * Detailed description of an error that was encountered during the task execution. You can use this * information to help troubleshoot issues. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withErrorDetail(String errorDetail) { setErrorDetail(errorDetail); return this; } /** ** The time that the task was created. *
* * @param creationTime * The time that the task was created. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** ** The time that the task was created. *
* * @return The time that the task was created. */ public java.util.Date getCreationTime() { return this.creationTime; } /** ** The time that the task was created. *
* * @param creationTime * The time that the task was created. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** ** A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
* * @return A list of filter rules that include specific data during your transfer. For more information and * examples, see Filtering * data transferred by DataSync. */ public java.util.List* A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
* * @param 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 setIncludes(java.util.Collection* 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 * {@link #setIncludes(java.util.Collection)} or {@link #withIncludes(java.util.Collection)} if you want to override * the existing values. *
* * @param includes * A list of filter rules that include specific data during your transfer. For more information and examples, * see Filtering data * transferred by DataSync. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withIncludes(FilterRule... includes) { if (this.includes == null) { setIncludes(new java.util.ArrayList* A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by * DataSync. *
* * @param includes * A list of filter rules that include specific data during your transfer. For more information and examples, * see Filtering data * transferred by DataSync. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeTaskResult withIncludes(java.util.Collection