1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_task_execution::_start_task_execution_output::StartTaskExecutionOutputBuilder;
pub use crate::operation::start_task_execution::_start_task_execution_input::StartTaskExecutionInputBuilder;
/// Fluent builder constructing a request to `StartTaskExecution`.
///
/// <p>Starts an DataSync task. For each task, you can only run one task execution at a time.</p>
/// <p>There are several phases to a task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses">Task execution statuses</a>.</p> <important>
/// <p>If you're planning to transfer data to or from an Amazon S3 location, review <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how DataSync can affect your S3 request charges</a> and the <a href="http://aws.amazon.com/datasync/pricing/">DataSync pricing page</a> before you begin.</p>
/// </important>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartTaskExecutionFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_task_execution::builders::StartTaskExecutionInputBuilder,
}
impl StartTaskExecutionFluentBuilder {
/// Creates a new `StartTaskExecution`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn customize_middleware(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::start_task_execution::StartTaskExecution,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::start_task_execution::StartTaskExecutionError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
::std::result::Result::Ok(crate::client::customize::CustomizableOperation {
handle,
operation,
})
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn send_middleware(
self,
) -> ::std::result::Result<
crate::operation::start_task_execution::StartTaskExecutionOutput,
::aws_smithy_http::result::SdkError<
crate::operation::start_task_execution::StartTaskExecutionError,
>,
> {
let op = self
.inner
.build()
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::start_task_execution::StartTaskExecutionOutput,
::aws_smithy_http::result::SdkError<
crate::operation::start_task_execution::StartTaskExecutionError,
>,
> {
self.send_middleware().await
}
/// Consumes this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::start_task_execution::StartTaskExecution,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::start_task_execution::StartTaskExecutionError,
>,
> {
self.customize_middleware().await
}
/// <p>Specifies the Amazon Resource Name (ARN) of the task that you want to start.</p>
pub fn task_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.task_arn(input.into());
self
}
/// <p>Specifies the Amazon Resource Name (ARN) of the task that you want to start.</p>
pub fn set_task_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_task_arn(input);
self
}
/// <p>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.</p>
/// <p>Each task setting has a default value. Unless you need to, you don't have to configure any of these <code>Options</code> before starting your task.</p>
pub fn override_options(mut self, input: crate::types::Options) -> Self {
self.inner = self.inner.override_options(input);
self
}
/// <p>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.</p>
/// <p>Each task setting has a default value. Unless you need to, you don't have to configure any of these <code>Options</code> before starting your task.</p>
pub fn set_override_options(
mut self,
input: ::std::option::Option<crate::types::Options>,
) -> Self {
self.inner = self.inner.set_override_options(input);
self
}
/// Appends an item to `Includes`.
///
/// To override the contents of this collection use [`set_includes`](Self::set_includes).
///
/// <p>Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
pub fn includes(mut self, input: crate::types::FilterRule) -> Self {
self.inner = self.inner.includes(input);
self
}
/// <p>Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
pub fn set_includes(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::FilterRule>>,
) -> Self {
self.inner = self.inner.set_includes(input);
self
}
/// Appends an item to `Excludes`.
///
/// To override the contents of this collection use [`set_excludes`](Self::set_excludes).
///
/// <p>Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
pub fn excludes(mut self, input: crate::types::FilterRule) -> Self {
self.inner = self.inner.excludes(input);
self
}
/// <p>Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
pub fn set_excludes(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::FilterRule>>,
) -> Self {
self.inner = self.inner.set_excludes(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.</p>
/// <p> <i>Tags</i> are key-value pairs that help you manage, filter, and search for your DataSync resources.</p>
pub fn tags(mut self, input: crate::types::TagListEntry) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.</p>
/// <p> <i>Tags</i> are key-value pairs that help you manage, filter, and search for your DataSync resources.</p>
pub fn set_tags(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::TagListEntry>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}