com.amazonaws.services.datasync.model

Class DescribeTaskExecutionResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.datasync.model.DescribeTaskExecutionResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeTaskExecutionResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

DescribeTaskExecutionResponse

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeTaskExecutionResult()

Method Summary

Modifier and Type	Method and Description
DescribeTaskExecutionResult	clone()
boolean	equals(Object obj)
Long	getBytesTransferred() The physical number of bytes transferred over the network.
Long	getBytesWritten() The number of logical bytes written to the destination AWS 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 determines which files to exclude from a task.
Long	getFilesTransferred() The actual number of files that was transferred over the network.
List<FilterRule>	getIncludes() A list of filter rules that determines which files to include when running a task.
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	setBytesTransferred(Long bytesTransferred) The physical number of bytes transferred over the network.
void	setBytesWritten(Long bytesWritten) The number of logical bytes written to the destination AWS 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 determines which files to exclude from a task.
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 determines which files to include when running a task.
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	withBytesTransferred(Long bytesTransferred) The physical number of bytes transferred over the network.
DescribeTaskExecutionResult	withBytesWritten(Long bytesWritten) The number of logical bytes written to the destination AWS 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 determines which files to exclude from a task.
DescribeTaskExecutionResult	withExcludes(FilterRule... excludes) A list of filter rules that determines which files to exclude from a task.
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 determines which files to include when running a task.
DescribeTaskExecutionResult	withIncludes(FilterRule... includes) A list of filter rules that determines which files to include when running a task.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeTaskExecutionResult

public DescribeTaskExecutionResult()

Method Detail

setTaskExecutionArn

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.

Parameters:

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.

getTaskExecutionArn

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.

Returns:

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.

withTaskExecutionArn

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

Parameters:

status - The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

See Also:

TaskExecutionStatus

getStatus

public String getStatus()

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

Returns:

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

See Also:

TaskExecutionStatus

withStatus

public DescribeTaskExecutionResult withStatus(String status)

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

Parameters:

status - The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskExecutionStatus

withStatus

public DescribeTaskExecutionResult withStatus(TaskExecutionStatus status)

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

Parameters:

status - The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskExecutionStatus

setOptions

public void setOptions(Options options)

Parameters:

options -

getOptions

public Options getOptions()

Returns:

withOptions

public DescribeTaskExecutionResult withOptions(Options options)

Parameters:

options -

Returns:

Returns a reference to this object so that method calls can be chained together.

getExcludes

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"

Returns:

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"

setExcludes

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"

Parameters:

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"

withExcludes

public DescribeTaskExecutionResult 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.

Parameters:

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"

Returns:

Returns a reference to this object so that method calls can be chained together.

withExcludes

public DescribeTaskExecutionResult 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"

Parameters:

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"

Returns:

Returns a reference to this object so that method calls can be chained together.

getIncludes

public List<FilterRule> getIncludes()

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Returns:

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

setIncludes

public void setIncludes(Collection<FilterRule> includes)

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Parameters:

includes - A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

withIncludes

public DescribeTaskExecutionResult withIncludes(FilterRule... includes)

A list of filter rules that determines which files to include when running a task. The list should contain 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.

Parameters:

includes - A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Returns:

Returns a reference to this object so that method calls can be chained together.

withIncludes

public DescribeTaskExecutionResult withIncludes(Collection<FilterRule> includes)

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Parameters:

includes - A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date startTime)

The time that the task execution was started.

Parameters:

startTime - The time that the task execution was started.

getStartTime

public Date getStartTime()

The time that the task execution was started.

Returns:

The time that the task execution was started.

withStartTime

public DescribeTaskExecutionResult withStartTime(Date startTime)

The time that the task execution was started.

Parameters:

startTime - The time that the task execution was started.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEstimatedFilesToTransfer

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. 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.

Parameters:

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. 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.

getEstimatedFilesToTransfer

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. 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.

Returns:

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. 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.

withEstimatedFilesToTransfer

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. 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.

Parameters:

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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEstimatedBytesToTransfer

public void setEstimatedBytesToTransfer(Long estimatedBytesToTransfer)

The estimated physical number of bytes that is to be transferred over the network.

Parameters:

estimatedBytesToTransfer - The estimated physical number of bytes that is to be transferred over the network.

getEstimatedBytesToTransfer

public Long getEstimatedBytesToTransfer()

The estimated physical number of bytes that is to be transferred over the network.

Returns:

The estimated physical number of bytes that is to be transferred over the network.

withEstimatedBytesToTransfer

public DescribeTaskExecutionResult withEstimatedBytesToTransfer(Long estimatedBytesToTransfer)

The estimated physical number of bytes that is to be transferred over the network.

Parameters:

estimatedBytesToTransfer - The estimated physical number of bytes that is to be transferred over the network.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilesTransferred

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. 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. This value can also be greater than EstimatedFilesTransferred in some cases. 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.

Parameters:

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. 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. This value can also be greater than EstimatedFilesTransferred in some cases. 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.

getFilesTransferred

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. 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. This value can also be greater than EstimatedFilesTransferred in some cases. 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.

Returns:

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. 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. This value can also be greater than EstimatedFilesTransferred in some cases. 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.

withFilesTransferred

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. 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. This value can also be greater than EstimatedFilesTransferred in some cases. 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.

Parameters:

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. 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. This value can also be greater than EstimatedFilesTransferred in some cases. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBytesWritten

public void setBytesWritten(Long bytesWritten)

The number of logical bytes written to the destination AWS storage resource.

Parameters:

bytesWritten - The number of logical bytes written to the destination AWS storage resource.

getBytesWritten

public Long getBytesWritten()

The number of logical bytes written to the destination AWS storage resource.

Returns:

The number of logical bytes written to the destination AWS storage resource.

withBytesWritten

public DescribeTaskExecutionResult withBytesWritten(Long bytesWritten)

The number of logical bytes written to the destination AWS storage resource.

Parameters:

bytesWritten - The number of logical bytes written to the destination AWS storage resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBytesTransferred

public void setBytesTransferred(Long bytesTransferred)

The physical number of bytes transferred over the network.

Parameters:

bytesTransferred - The physical number of bytes transferred over the network.

getBytesTransferred

public Long getBytesTransferred()

The physical number of bytes transferred over the network.

Returns:

The physical number of bytes transferred over the network.

withBytesTransferred

public DescribeTaskExecutionResult withBytesTransferred(Long bytesTransferred)

The physical number of bytes transferred over the network.

Parameters:

bytesTransferred - The physical number of bytes transferred over the network.

Returns:

Returns a reference to this object so that method calls can be chained together.

setResult

public void setResult(TaskExecutionResultDetail result)

The result of the task execution.

Parameters:

result - The result of the task execution.

getResult

public TaskExecutionResultDetail getResult()

The result of the task execution.

Returns:

The result of the task execution.

withResult

public DescribeTaskExecutionResult withResult(TaskExecutionResultDetail result)

The result of the task execution.

Parameters:

result - The result of the task execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeTaskExecutionResult clone()

Overrides:

clone in class Object