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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_task::_create_task_output::CreateTaskOutputBuilder;
pub use crate::operation::create_task::_create_task_input::CreateTaskInputBuilder;
/// Fluent builder constructing a request to `CreateTask`.
///
/// <p>Configures a task, which defines where and how DataSync transfers your data.</p>
/// <p>A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).</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 CreateTaskFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_task::builders::CreateTaskInputBuilder,
}
impl CreateTaskFluentBuilder {
/// Creates a new `CreateTask`.
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::create_task::CreateTask,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<crate::operation::create_task::CreateTaskError>,
> {
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::create_task::CreateTaskOutput,
::aws_smithy_http::result::SdkError<crate::operation::create_task::CreateTaskError>,
> {
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::create_task::CreateTaskOutput,
::aws_smithy_http::result::SdkError<crate::operation::create_task::CreateTaskError>,
> {
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::create_task::CreateTask,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<crate::operation::create_task::CreateTaskError>,
> {
self.customize_middleware().await
}
/// <p>The Amazon Resource Name (ARN) of the source location for the task.</p>
pub fn source_location_arn(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.source_location_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the source location for the task.</p>
pub fn set_source_location_arn(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_source_location_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location. </p>
pub fn destination_location_arn(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.destination_location_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location. </p>
pub fn set_destination_location_arn(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_destination_location_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. </p>
pub fn cloud_watch_log_group_arn(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.cloud_watch_log_group_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. </p>
pub fn set_cloud_watch_log_group_arn(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_cloud_watch_log_group_arn(input);
self
}
/// <p>The name of a task. This value is a text reference that is used to identify the task in the console. </p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The name of a task. This value is a text reference that is used to identify the task in the console. </p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.</p>
/// <p>You can also override these options before starting an individual run of a task (also known as a <i>task execution</i>). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
pub fn options(mut self, input: crate::types::Options) -> Self {
self.inner = self.inner.options(input);
self
}
/// <p>Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.</p>
/// <p>You can also override these options before starting an individual run of a task (also known as a <i>task execution</i>). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
pub fn set_options(mut self, input: ::std::option::Option<crate::types::Options>) -> Self {
self.inner = self.inner.set_options(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 exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</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 exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</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
}
/// <p>Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>
pub fn schedule(mut self, input: crate::types::TaskSchedule) -> Self {
self.inner = self.inner.schedule(input);
self
}
/// <p>Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>
pub fn set_schedule(
mut self,
input: ::std::option::Option<crate::types::TaskSchedule>,
) -> Self {
self.inner = self.inner.set_schedule(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.</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.</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
}
/// 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 include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</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 include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</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
}
}