/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the datasync-2018-11-09.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.DataSync.Model
{
///
/// DescribeTaskExecutionResponse
///
public partial class DescribeTaskExecutionResponse : AmazonWebServiceResponse
{
private long? _bytesCompressed;
private long? _bytesTransferred;
private long? _bytesWritten;
private long? _estimatedBytesToTransfer;
private long? _estimatedFilesToTransfer;
private List _excludes = new List();
private long? _filesTransferred;
private List _includes = new List();
private Options _options;
private TaskExecutionResultDetail _result;
private DateTime? _startTime;
private TaskExecutionStatus _status;
private string _taskExecutionArn;
///
/// Gets and sets the property 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 BytesCompressed
{
get { return this._bytesCompressed.GetValueOrDefault(); }
set { this._bytesCompressed = value; }
}
// Check to see if BytesCompressed property is set
internal bool IsSetBytesCompressed()
{
return this._bytesCompressed.HasValue;
}
///
/// Gets and sets the property 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 BytesTransferred
{
get { return this._bytesTransferred.GetValueOrDefault(); }
set { this._bytesTransferred = value; }
}
// Check to see if BytesTransferred property is set
internal bool IsSetBytesTransferred()
{
return this._bytesTransferred.HasValue;
}
///
/// Gets and sets the property BytesWritten.
///
/// The number of logical bytes written to the destination Amazon Web Services storage
/// resource.
///
///
public long BytesWritten
{
get { return this._bytesWritten.GetValueOrDefault(); }
set { this._bytesWritten = value; }
}
// Check to see if BytesWritten property is set
internal bool IsSetBytesWritten()
{
return this._bytesWritten.HasValue;
}
///
/// Gets and sets the property EstimatedBytesToTransfer.
///
/// The estimated physical number of bytes that is to be transferred over the network.
///
///
public long EstimatedBytesToTransfer
{
get { return this._estimatedBytesToTransfer.GetValueOrDefault(); }
set { this._estimatedBytesToTransfer = value; }
}
// Check to see if EstimatedBytesToTransfer property is set
internal bool IsSetEstimatedBytesToTransfer()
{
return this._estimatedBytesToTransfer.HasValue;
}
///
/// Gets and sets the property 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 EstimatedFilesToTransfer
{
get { return this._estimatedFilesToTransfer.GetValueOrDefault(); }
set { this._estimatedFilesToTransfer = value; }
}
// Check to see if EstimatedFilesToTransfer property is set
internal bool IsSetEstimatedFilesToTransfer()
{
return this._estimatedFilesToTransfer.HasValue;
}
///
/// Gets and sets the property Excludes.
///
/// A list of filter rules that exclude specific data during your transfer. For more information
/// and examples, see Filtering
/// data transferred by DataSync.
///
///
[AWSProperty(Min=0, Max=1)]
public List Excludes
{
get { return this._excludes; }
set { this._excludes = value; }
}
// Check to see if Excludes property is set
internal bool IsSetExcludes()
{
return this._excludes != null && this._excludes.Count > 0;
}
///
/// Gets and sets the property 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 FilesTransferred
{
get { return this._filesTransferred.GetValueOrDefault(); }
set { this._filesTransferred = value; }
}
// Check to see if FilesTransferred property is set
internal bool IsSetFilesTransferred()
{
return this._filesTransferred.HasValue;
}
///
/// Gets and sets the property Includes.
///
/// A list of filter rules that include specific data during your transfer. For more information
/// and examples, see Filtering
/// data transferred by DataSync.
///
///
[AWSProperty(Min=0, Max=1)]
public List Includes
{
get { return this._includes; }
set { this._includes = value; }
}
// Check to see if Includes property is set
internal bool IsSetIncludes()
{
return this._includes != null && this._includes.Count > 0;
}
///
/// Gets and sets the property Options.
///
public Options Options
{
get { return this._options; }
set { this._options = value; }
}
// Check to see if Options property is set
internal bool IsSetOptions()
{
return this._options != null;
}
///
/// Gets and sets the property Result.
///
/// The result of the task execution.
///
///
public TaskExecutionResultDetail Result
{
get { return this._result; }
set { this._result = value; }
}
// Check to see if Result property is set
internal bool IsSetResult()
{
return this._result != null;
}
///
/// Gets and sets the property StartTime.
///
/// The time that the task execution was started.
///
///
public DateTime StartTime
{
get { return this._startTime.GetValueOrDefault(); }
set { this._startTime = value; }
}
// Check to see if StartTime property is set
internal bool IsSetStartTime()
{
return this._startTime.HasValue;
}
///
/// Gets and sets the property Status.
///
/// The status of the task execution.
///
///
///
/// For detailed information about task execution statuses, see Understanding Task Statuses
/// in the DataSync User Guide.
///
///
public TaskExecutionStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property 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
.
///
///
///
[AWSProperty(Max=128)]
public string TaskExecutionArn
{
get { return this._taskExecutionArn; }
set { this._taskExecutionArn = value; }
}
// Check to see if TaskExecutionArn property is set
internal bool IsSetTaskExecutionArn()
{
return this._taskExecutionArn != null;
}
}
}