@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 syncing 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 destination elastic network interfaces (ENIs) that were created for your
subnet.
|
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 determines which files to exclude from a task.
|
List<FilterRule> |
getIncludes()
A list of filter rules that determines which files to include when running a task.
|
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 . |
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 source elastic network interfaces (ENIs) that were created for your
subnet.
|
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 Amazon Web Services storage resource's location.
|
void |
setDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your
subnet.
|
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 determines which files to exclude from a task.
|
void |
setIncludes(Collection<FilterRule> includes)
A list of filter rules that determines which files to include when running a task.
|
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 |
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 source elastic network interfaces (ENIs) that were created for your
subnet.
|
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 Amazon Web Services storage resource's location.
|
DescribeTaskResult |
withDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your
subnet.
|
DescribeTaskResult |
withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your
subnet.
|
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 determines which files to exclude from a task.
|
DescribeTaskResult |
withExcludes(FilterRule... excludes)
A list of filter rules that determines which files to exclude from a task.
|
DescribeTaskResult |
withIncludes(Collection<FilterRule> includes)
A list of filter rules that determines which files to include when running a task.
|
DescribeTaskResult |
withIncludes(FilterRule... includes)
A list of filter rules that determines which files to include when running a task.
|
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 |
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 source elastic network interfaces (ENIs) that were created for your
subnet.
|
DescribeTaskResult |
withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for your
subnet.
|
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.
|
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 syncing files.
currentTaskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that is syncing files.public String getCurrentTaskExecutionArn()
The Amazon Resource Name (ARN) of the task execution that is syncing files.
public DescribeTaskResult withCurrentTaskExecutionArn(String currentTaskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that is syncing files.
currentTaskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that is syncing 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 source elastic network interfaces (ENIs) that were created for your subnet.
public void setSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for your subnet.
sourceNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for
your subnet.public DescribeTaskResult withSourceNetworkInterfaceArns(String... sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for your subnet.
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 source elastic network interfaces (ENIs) that were created for
your subnet.public DescribeTaskResult withSourceNetworkInterfaceArns(Collection<String> sourceNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for your subnet.
sourceNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for
your subnet.public List<String> getDestinationNetworkInterfaceArns()
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.
public void setDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.
destinationNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created
for your subnet.public DescribeTaskResult withDestinationNetworkInterfaceArns(String... destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.
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 destination elastic network interfaces (ENIs) that were created
for your subnet.public DescribeTaskResult withDestinationNetworkInterfaceArns(Collection<String> destinationNetworkInterfaceArns)
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.
destinationNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created
for your subnet.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 StartTaskExecution
operation.
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 StartTaskExecution operation.
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 StartTaskExecution
operation.
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 StartTaskExecution operation.
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 StartTaskExecution
operation.
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 StartTaskExecution operation.
public List<FilterRule> getExcludes()
A list of filter rules that determines which files to exclude from a task. The list should contain a single
filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2"
.
"/folder1|/folder2"
.
public void setExcludes(Collection<FilterRule> excludes)
A list of filter rules that determines which files to exclude from a task. The list should contain a single
filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2"
.
excludes
- A list of filter rules that determines which files to exclude from a task. The list should contain a
single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is,
a pipe), for example, "/folder1|/folder2"
.
public DescribeTaskResult withExcludes(FilterRule... excludes)
A list of filter rules that determines which files to exclude from a task. The list should contain a single
filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2"
.
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 determines which files to exclude from a task. The list should contain a
single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is,
a pipe), for example, "/folder1|/folder2"
.
public DescribeTaskResult withExcludes(Collection<FilterRule> excludes)
A list of filter rules that determines which files to exclude from a task. The list should contain a single
filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2"
.
excludes
- A list of filter rules that determines which files to exclude from a task. The list should contain a
single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is,
a pipe), for example, "/folder1|/folder2"
.
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 determines which files to include when running a task. The pattern contains a single
filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2
".
"/folder1|/folder2
".public void setIncludes(Collection<FilterRule> includes)
A list of filter rules that determines which files to include when running a task. The pattern contains a single
filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2
".
includes
- A list of filter rules that determines which files to include when running a task. The pattern contains a
single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is,
a pipe), for example, "/folder1|/folder2
".public DescribeTaskResult withIncludes(FilterRule... includes)
A list of filter rules that determines which files to include when running a task. The pattern contains a single
filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2
".
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 determines which files to include when running a task. The pattern contains a
single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is,
a pipe), for example, "/folder1|/folder2
".public DescribeTaskResult withIncludes(Collection<FilterRule> includes)
A list of filter rules that determines which files to include when running a task. The pattern contains a single
filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for
example, "/folder1|/folder2
".
includes
- A list of filter rules that determines which files to include when running a task. The pattern contains a
single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is,
a pipe), for example, "/folder1|/folder2
".public String toString()
toString
in class Object
Object.toString()
public DescribeTaskResult clone()