Struct aws_sdk_datasync::operation::describe_task_execution::builders::DescribeTaskExecutionOutputBuilder

#[non_exhaustive]
pub struct DescribeTaskExecutionOutputBuilder { /* private fields */ }

A builder for DescribeTaskExecutionOutput.

Implementations

impl DescribeTaskExecutionOutputBuilder

pub fn task_execution_arn(self, input: impl Into<String>) -> Self

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 set_task_execution_arn(self, input: Option<String>) -> Self

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 get_task_execution_arn(&self) -> &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.

pub fn status(self, input: TaskExecutionStatus) -> Self

The status of the task execution.

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

pub fn set_status(self, input: Option<TaskExecutionStatus>) -> Self

The status of the task execution.

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

pub fn get_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, input: Options) -> Self

Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.

Each task setting has a default value. Unless you need to, you don't have to configure any of these Options before starting your task.

pub fn set_options(self, input: Option<Options>) -> Self

Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.

Each task setting has a default value. Unless you need to, you don't have to configure any of these Options before starting your task.

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

Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.

Each task setting has a default value. Unless you need to, you don't have to configure any of these Options before starting your task.

pub fn excludes(self, input: FilterRule) -> Self

Appends an item to excludes.

To override the contents of this collection use set_excludes.

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

pub fn set_excludes(self, input: Option<Vec<FilterRule>>) -> Self

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

pub fn get_excludes(&self) -> &Option<Vec<FilterRule>>

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

pub fn includes(self, input: FilterRule) -> Self

Appends an item to includes.

To override the contents of this collection use set_includes.

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

pub fn set_includes(self, input: Option<Vec<FilterRule>>) -> Self

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

pub fn get_includes(&self) -> &Option<Vec<FilterRule>>

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

pub fn start_time(self, input: DateTime) -> Self

The time that the task execution was started.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The time that the task execution was started.

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

The time that the task execution was started.

pub fn estimated_files_to_transfer(self, input: i64) -> Self

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.

pub fn set_estimated_files_to_transfer(self, input: Option<i64>) -> Self

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.

pub fn get_estimated_files_to_transfer(&self) -> &Option<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 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.

pub fn estimated_bytes_to_transfer(self, input: i64) -> Self

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

pub fn set_estimated_bytes_to_transfer(self, input: Option<i64>) -> Self

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

pub fn get_estimated_bytes_to_transfer(&self) -> &Option<i64>

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

pub fn files_transferred(self, input: i64) -> Self

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.

pub fn set_files_transferred(self, input: Option<i64>) -> Self

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.

pub fn get_files_transferred(&self) -> &Option<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 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.

pub fn bytes_written(self, input: i64) -> Self

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

pub fn set_bytes_written(self, input: Option<i64>) -> Self

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

pub fn get_bytes_written(&self) -> &Option<i64>

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

pub fn bytes_transferred(self, input: i64) -> Self

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

pub fn set_bytes_transferred(self, input: Option<i64>) -> Self

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

pub fn get_bytes_transferred(&self) -> &Option<i64>

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

pub fn result(self, input: TaskExecutionResultDetail) -> Self

The result of the task execution.

pub fn set_result(self, input: Option<TaskExecutionResultDetail>) -> Self

The result of the task execution.

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

The result of the task execution.

pub fn bytes_compressed(self, input: i64) -> Self

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.

pub fn set_bytes_compressed(self, input: Option<i64>) -> Self

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.

pub fn get_bytes_compressed(&self) -> &Option<i64>

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.

pub fn build(self) -> DescribeTaskExecutionOutput

Consumes the builder and constructs a DescribeTaskExecutionOutput.

Trait Implementations

impl Clone for DescribeTaskExecutionOutputBuilder

fn clone(&self) -> DescribeTaskExecutionOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeTaskExecutionOutputBuilder

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

Formats the value using the given formatter.

impl Default for DescribeTaskExecutionOutputBuilder

fn default() -> DescribeTaskExecutionOutputBuilder

Returns the “default value” for a type.

impl PartialEq<DescribeTaskExecutionOutputBuilder> for DescribeTaskExecutionOutputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeTaskExecutionOutputBuilder