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 ARN of the task execution that you wanted information about. 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 ARN of the task execution that you wanted information about. 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 ARN of the task execution that you wanted information about. 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.

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

The status of the task execution.

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

The status of the task execution.

pub fn options(self, input: Options) -> Self

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

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

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

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

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

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 manifest_config(self, input: ManifestConfig) -> Self

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

pub fn set_manifest_config(self, input: Option<ManifestConfig>) -> Self

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

pub fn get_manifest_config(&self) -> &Option<ManifestConfig>

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

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

The time when the task execution started.

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

The time when the task execution started.

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

The time when the task execution started.

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

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

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

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

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

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

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

The estimated physical number of bytes that will transfer over the network.

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

The estimated physical number of bytes that will transfer over the network.

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

The estimated physical number of bytes that will transfer over the network.

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

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

If DataSync fails to transfer something, 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 exact indication of what transferred or to monitor your task execution.

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

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

If DataSync fails to transfer something, 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 exact indication of what transferred or to monitor your task execution.

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

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

If DataSync fails to transfer something, 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 exact indication of what transferred or to monitor your task execution.

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

The number of logical bytes written to the destination location.

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

The number of logical bytes written to the destination location.

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

The number of logical bytes written to the destination location.

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 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 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 task_report_config(self, input: TaskReportConfig) -> Self

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

pub fn set_task_report_config(self, input: Option<TaskReportConfig>) -> Self

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

pub fn get_task_report_config(&self) -> &Option<TaskReportConfig>

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

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

The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

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

The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

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

The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

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

The number of files, objects, and directories that DataSync skipped during your transfer.

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

The number of files, objects, and directories that DataSync skipped during your transfer.

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

The number of files, objects, and directories that DataSync skipped during your transfer.

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

The number of files, objects, and directories that DataSync verified during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

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

The number of files, objects, and directories that DataSync verified during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

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

The number of files, objects, and directories that DataSync verified during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

pub fn report_result(self, input: ReportResult) -> Self

Indicates whether DataSync generated a complete task report for your transfer.

pub fn set_report_result(self, input: Option<ReportResult>) -> Self

Indicates whether DataSync generated a complete task report for your transfer.

pub fn get_report_result(&self) -> &Option<ReportResult>

Indicates whether DataSync generated a complete task report for your transfer.

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

The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

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

The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

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

The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

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