@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
DescribeTaskExecutionResponse
Constructor and Description |
---|
DescribeTaskExecutionResult() |
Modifier and Type | Method and Description |
---|---|
DescribeTaskExecutionResult |
clone() |
boolean |
equals(Object obj) |
Long |
getBytesCompressed()
The physical number of bytes transferred over the network after compression was applied.
|
Long |
getBytesTransferred()
The total number of bytes that are involved in the transfer.
|
Long |
getBytesWritten()
The number of logical bytes written to the destination Amazon Web Services storage resource.
|
Long |
getEstimatedBytesToTransfer()
The estimated physical number of bytes that is to be transferred over the network.
|
Long |
getEstimatedFilesToTransfer()
The expected number of files that is to be transferred over the network.
|
List<FilterRule> |
getExcludes()
A list of filter rules that exclude specific data during your transfer.
|
Long |
getFilesTransferred()
The actual number of files that was transferred over the network.
|
List<FilterRule> |
getIncludes()
A list of filter rules that include specific data during your transfer.
|
Options |
getOptions() |
TaskExecutionResultDetail |
getResult()
The result of the task execution.
|
Date |
getStartTime()
The time that the task execution was started.
|
String |
getStatus()
The status of the task execution.
|
String |
getTaskExecutionArn()
The Amazon Resource Name (ARN) of the task execution that was described.
|
int |
hashCode() |
void |
setBytesCompressed(Long bytesCompressed)
The physical number of bytes transferred over the network after compression was applied.
|
void |
setBytesTransferred(Long bytesTransferred)
The total number of bytes that are involved in the transfer.
|
void |
setBytesWritten(Long bytesWritten)
The number of logical bytes written to the destination Amazon Web Services storage resource.
|
void |
setEstimatedBytesToTransfer(Long estimatedBytesToTransfer)
The estimated physical number of bytes that is to be transferred over the network.
|
void |
setEstimatedFilesToTransfer(Long estimatedFilesToTransfer)
The expected number of files that is to be transferred over the network.
|
void |
setExcludes(Collection<FilterRule> excludes)
A list of filter rules that exclude specific data during your transfer.
|
void |
setFilesTransferred(Long filesTransferred)
The actual number of files that was transferred over the network.
|
void |
setIncludes(Collection<FilterRule> includes)
A list of filter rules that include specific data during your transfer.
|
void |
setOptions(Options options) |
void |
setResult(TaskExecutionResultDetail result)
The result of the task execution.
|
void |
setStartTime(Date startTime)
The time that the task execution was started.
|
void |
setStatus(String status)
The status of the task execution.
|
void |
setTaskExecutionArn(String taskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that was described.
|
String |
toString()
Returns a string representation of this object.
|
DescribeTaskExecutionResult |
withBytesCompressed(Long bytesCompressed)
The physical number of bytes transferred over the network after compression was applied.
|
DescribeTaskExecutionResult |
withBytesTransferred(Long bytesTransferred)
The total number of bytes that are involved in the transfer.
|
DescribeTaskExecutionResult |
withBytesWritten(Long bytesWritten)
The number of logical bytes written to the destination Amazon Web Services storage resource.
|
DescribeTaskExecutionResult |
withEstimatedBytesToTransfer(Long estimatedBytesToTransfer)
The estimated physical number of bytes that is to be transferred over the network.
|
DescribeTaskExecutionResult |
withEstimatedFilesToTransfer(Long estimatedFilesToTransfer)
The expected number of files that is to be transferred over the network.
|
DescribeTaskExecutionResult |
withExcludes(Collection<FilterRule> excludes)
A list of filter rules that exclude specific data during your transfer.
|
DescribeTaskExecutionResult |
withExcludes(FilterRule... excludes)
A list of filter rules that exclude specific data during your transfer.
|
DescribeTaskExecutionResult |
withFilesTransferred(Long filesTransferred)
The actual number of files that was transferred over the network.
|
DescribeTaskExecutionResult |
withIncludes(Collection<FilterRule> includes)
A list of filter rules that include specific data during your transfer.
|
DescribeTaskExecutionResult |
withIncludes(FilterRule... includes)
A list of filter rules that include specific data during your transfer.
|
DescribeTaskExecutionResult |
withOptions(Options options) |
DescribeTaskExecutionResult |
withResult(TaskExecutionResultDetail result)
The result of the task execution.
|
DescribeTaskExecutionResult |
withStartTime(Date startTime)
The time that the task execution was started.
|
DescribeTaskExecutionResult |
withStatus(String status)
The status of the task execution.
|
DescribeTaskExecutionResult |
withStatus(TaskExecutionStatus status)
The status of the task execution.
|
DescribeTaskExecutionResult |
withTaskExecutionArn(String taskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that was described.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setTaskExecutionArn(String taskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn
is
hierarchical and includes TaskArn
for the task that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
taskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn
is
hierarchical and includes TaskArn
for the task that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
public String getTaskExecutionArn()
The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn
is
hierarchical and includes TaskArn
for the task that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
TaskExecutionArn
is
hierarchical and includes TaskArn
for the task that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
public DescribeTaskExecutionResult withTaskExecutionArn(String taskExecutionArn)
The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn
is
hierarchical and includes TaskArn
for the task that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
taskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn
is
hierarchical and includes TaskArn
for the task that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
public void setStatus(String status)
The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
status
- The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskExecutionStatus
public String getStatus()
The status of the task execution.
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.
TaskExecutionStatus
public DescribeTaskExecutionResult withStatus(String status)
The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
status
- The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskExecutionStatus
public DescribeTaskExecutionResult withStatus(TaskExecutionStatus status)
The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
status
- The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
TaskExecutionStatus
public void setOptions(Options options)
options
- public Options getOptions()
public DescribeTaskExecutionResult withOptions(Options options)
options
- 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 DescribeTaskExecutionResult 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 DescribeTaskExecutionResult 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 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 DescribeTaskExecutionResult 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 DescribeTaskExecutionResult 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 setStartTime(Date startTime)
The time that the task execution was started.
startTime
- The time that the task execution was started.public Date getStartTime()
The time that the task execution was started.
public DescribeTaskExecutionResult withStartTime(Date startTime)
The time that the task execution was started.
startTime
- The time that the task execution was started.public void setEstimatedFilesToTransfer(Long estimatedFilesToTransfer)
The expected number of files that is to be transferred over the network. This value is calculated during the
PREPARING
phase before the TRANSFERRING
phase of the task execution. This value is the
expected number of files to be transferred. It's calculated based on comparing the content of the source and
destination locations and finding the delta that needs to be transferred.
estimatedFilesToTransfer
- The expected number of files that is to be transferred over the network. This value is calculated during
the PREPARING
phase before the TRANSFERRING
phase of the task execution. This
value is the expected number of files to be transferred. It's calculated based on comparing the content of
the source and destination locations and finding the delta that needs to be transferred.public Long getEstimatedFilesToTransfer()
The expected number of files that is to be transferred over the network. This value is calculated during the
PREPARING
phase before the TRANSFERRING
phase of the task execution. This value is the
expected number of files to be transferred. It's calculated based on comparing the content of the source and
destination locations and finding the delta that needs to be transferred.
PREPARING
phase before the TRANSFERRING
phase of the task execution. This
value is the expected number of files to be transferred. It's calculated based on comparing the content
of the source and destination locations and finding the delta that needs to be transferred.public DescribeTaskExecutionResult withEstimatedFilesToTransfer(Long estimatedFilesToTransfer)
The expected number of files that is to be transferred over the network. This value is calculated during the
PREPARING
phase before the TRANSFERRING
phase of the task execution. This value is the
expected number of files to be transferred. It's calculated based on comparing the content of the source and
destination locations and finding the delta that needs to be transferred.
estimatedFilesToTransfer
- The expected number of files that is to be transferred over the network. This value is calculated during
the PREPARING
phase before the TRANSFERRING
phase of the task execution. This
value is the expected number of files to be transferred. It's calculated based on comparing the content of
the source and destination locations and finding the delta that needs to be transferred.public void setEstimatedBytesToTransfer(Long estimatedBytesToTransfer)
The estimated physical number of bytes that is to be transferred over the network.
estimatedBytesToTransfer
- The estimated physical number of bytes that is to be transferred over the network.public Long getEstimatedBytesToTransfer()
The estimated physical number of bytes that is to be transferred over the network.
public DescribeTaskExecutionResult withEstimatedBytesToTransfer(Long estimatedBytesToTransfer)
The estimated physical number of bytes that is to be transferred over the network.
estimatedBytesToTransfer
- The estimated physical number of bytes that is to be transferred over the network.public void setFilesTransferred(Long filesTransferred)
The actual number of files that was transferred over the network. This value is calculated and updated on an
ongoing basis during the TRANSFERRING
phase of the task execution. It's updated periodically when
each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer
. In some
cases, this value can also be greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file number or to
monitor your task execution.
filesTransferred
- The actual number of files that was transferred over the network. This value is calculated and updated on
an ongoing basis during the TRANSFERRING
phase of the task execution. It's updated
periodically when each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer
. In
some cases, this value can also be greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file number
or to monitor your task execution.
public Long getFilesTransferred()
The actual number of files that was transferred over the network. This value is calculated and updated on an
ongoing basis during the TRANSFERRING
phase of the task execution. It's updated periodically when
each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer
. In some
cases, this value can also be greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file number or to
monitor your task execution.
TRANSFERRING
phase of the task execution. It's updated
periodically when each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer
.
In some cases, this value can also be greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file
number or to monitor your task execution.
public DescribeTaskExecutionResult withFilesTransferred(Long filesTransferred)
The actual number of files that was transferred over the network. This value is calculated and updated on an
ongoing basis during the TRANSFERRING
phase of the task execution. It's updated periodically when
each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer
. In some
cases, this value can also be greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file number or to
monitor your task execution.
filesTransferred
- The actual number of files that was transferred over the network. This value is calculated and updated on
an ongoing basis during the TRANSFERRING
phase of the task execution. It's updated
periodically when each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer
. In
some cases, this value can also be greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file number
or to monitor your task execution.
public void setBytesWritten(Long bytesWritten)
The number of logical bytes written to the destination Amazon Web Services storage resource.
bytesWritten
- The number of logical bytes written to the destination Amazon Web Services storage resource.public Long getBytesWritten()
The number of logical bytes written to the destination Amazon Web Services storage resource.
public DescribeTaskExecutionResult withBytesWritten(Long bytesWritten)
The number of logical bytes written to the destination Amazon Web Services storage resource.
bytesWritten
- The number of logical bytes written to the destination Amazon Web Services storage resource.public void setBytesTransferred(Long bytesTransferred)
The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see
BytesCompressed
.
bytesTransferred
- The total number of bytes that are involved in the transfer. For the number of bytes sent over the
network, see BytesCompressed
.public Long getBytesTransferred()
The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see
BytesCompressed
.
BytesCompressed
.public DescribeTaskExecutionResult withBytesTransferred(Long bytesTransferred)
The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see
BytesCompressed
.
bytesTransferred
- The total number of bytes that are involved in the transfer. For the number of bytes sent over the
network, see BytesCompressed
.public void setResult(TaskExecutionResultDetail result)
The result of the task execution.
result
- The result of the task execution.public TaskExecutionResultDetail getResult()
The result of the task execution.
public DescribeTaskExecutionResult withResult(TaskExecutionResultDetail result)
The result of the task execution.
result
- The result of the task execution.public void setBytesCompressed(Long bytesCompressed)
The physical number of bytes transferred over the network after compression was applied. In most cases, this
number is less than BytesTransferred
unless the data isn't compressible.
bytesCompressed
- The physical number of bytes transferred over the network after compression was applied. In most cases,
this number is less than BytesTransferred
unless the data isn't compressible.public Long getBytesCompressed()
The physical number of bytes transferred over the network after compression was applied. In most cases, this
number is less than BytesTransferred
unless the data isn't compressible.
BytesTransferred
unless the data isn't compressible.public DescribeTaskExecutionResult withBytesCompressed(Long bytesCompressed)
The physical number of bytes transferred over the network after compression was applied. In most cases, this
number is less than BytesTransferred
unless the data isn't compressible.
bytesCompressed
- The physical number of bytes transferred over the network after compression was applied. In most cases,
this number is less than BytesTransferred
unless the data isn't compressible.public String toString()
toString
in class Object
Object.toString()
public DescribeTaskExecutionResult clone()