Struct aws_sdk_datasync::output::DescribeTaskExecutionOutput

#[non_exhaustive]
pub struct DescribeTaskExecutionOutput {
    pub task_execution_arn: Option<String>,
    pub status: Option<TaskExecutionStatus>,
    pub options: Option<Options>,
    pub excludes: Option<Vec<FilterRule>>,
    pub includes: Option<Vec<FilterRule>>,
    pub start_time: Option<DateTime>,
    pub estimated_files_to_transfer: i64,
    pub estimated_bytes_to_transfer: i64,
    pub files_transferred: i64,
    pub bytes_written: i64,
    pub bytes_transferred: i64,
    pub result: Option<TaskExecutionResultDetail>,
}

DescribeTaskExecutionResponse

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_execution_arn: Option<String>

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.

status: Option<TaskExecutionStatus>

The status of the task execution.

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

options: Option<Options>

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

excludes: Option<Vec<FilterRule>>

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"

includes: Option<Vec<FilterRule>>

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"

start_time: Option<DateTime>

The time that the task execution was started.

estimated_files_to_transfer: i64

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.

estimated_bytes_to_transfer: i64

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

files_transferred: i64

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.

bytes_written: i64

The number of logical bytes written to the destination Amazon Web Services storage resource.

bytes_transferred: i64

The physical number of bytes transferred over the network.

result: Option<TaskExecutionResultDetail>

The result of the task execution.

Implementations

impl DescribeTaskExecutionOutput

pub fn task_execution_arn(&self) -> Option<&str>

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.

pub fn status(&self) -> Option<&TaskExecutionStatus>

The status of the task execution.

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

pub fn options(&self) -> Option<&Options>

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

pub fn excludes(&self) -> Option<&[FilterRule]>

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"

pub fn includes(&self) -> Option<&[FilterRule]>

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"

pub fn start_time(&self) -> Option<&DateTime>

The time that the task execution was started.

pub fn estimated_files_to_transfer(&self) -> i64

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.

pub fn estimated_bytes_to_transfer(&self) -> i64

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

pub fn files_transferred(&self) -> i64

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.

pub fn bytes_written(&self) -> i64

The number of logical bytes written to the destination Amazon Web Services storage resource.

pub fn bytes_transferred(&self) -> i64

The physical number of bytes transferred over the network.

pub fn result(&self) -> Option<&TaskExecutionResultDetail>

The result of the task execution.

impl DescribeTaskExecutionOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeTaskExecutionOutput

Trait Implementations

impl Clone for DescribeTaskExecutionOutput

fn clone(&self) -> DescribeTaskExecutionOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTaskExecutionOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DescribeTaskExecutionOutput> for DescribeTaskExecutionOutput

fn eq(&self, other: &DescribeTaskExecutionOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeTaskExecutionOutput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeTaskExecutionOutput