pub struct UpdateTaskFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateTask
.
Updates the configuration of a task, which defines where and how DataSync transfers your data.
Implementations§
Source§impl UpdateTaskFluentBuilder
impl UpdateTaskFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateTaskInputBuilder
pub fn as_input(&self) -> &UpdateTaskInputBuilder
Access the UpdateTask as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateTaskOutput, SdkError<UpdateTaskError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateTaskOutput, SdkError<UpdateTaskError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateTaskOutput, UpdateTaskError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateTaskOutput, UpdateTaskError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn task_arn(self, input: impl Into<String>) -> Self
pub fn task_arn(self, input: impl Into<String>) -> Self
Specifies the ARN of the task that you want to update.
Sourcepub fn set_task_arn(self, input: Option<String>) -> Self
pub fn set_task_arn(self, input: Option<String>) -> Self
Specifies the ARN of the task that you want to update.
Sourcepub fn get_task_arn(&self) -> &Option<String>
pub fn get_task_arn(&self) -> &Option<String>
Specifies the ARN of the task that you want to update.
Sourcepub fn options(self, input: Options) -> Self
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.
Sourcepub fn set_options(self, input: Option<Options>) -> Self
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.
Sourcepub fn get_options(&self) -> &Option<Options>
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.
Sourcepub fn excludes(self, input: FilterRule) -> Self
pub fn excludes(self, input: FilterRule) -> Self
Appends an item to Excludes
.
To override the contents of this collection use set_excludes
.
Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
Sourcepub fn set_excludes(self, input: Option<Vec<FilterRule>>) -> Self
pub fn set_excludes(self, input: Option<Vec<FilterRule>>) -> Self
Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
Sourcepub fn get_excludes(&self) -> &Option<Vec<FilterRule>>
pub fn get_excludes(&self) -> &Option<Vec<FilterRule>>
Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
Sourcepub fn schedule(self, input: TaskSchedule) -> Self
pub fn schedule(self, input: TaskSchedule) -> Self
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
Sourcepub fn set_schedule(self, input: Option<TaskSchedule>) -> Self
pub fn set_schedule(self, input: Option<TaskSchedule>) -> Self
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
Sourcepub fn get_schedule(&self) -> &Option<TaskSchedule>
pub fn get_schedule(&self) -> &Option<TaskSchedule>
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
Sourcepub fn cloud_watch_log_group_arn(self, input: impl Into<String>) -> Self
pub fn cloud_watch_log_group_arn(self, input: impl Into<String>) -> Self
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For Enhanced mode tasks, you must use /aws/datasync
as your log group name. For example:
arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*
For more information, see Monitoring data transfers with CloudWatch Logs.
Sourcepub fn set_cloud_watch_log_group_arn(self, input: Option<String>) -> Self
pub fn set_cloud_watch_log_group_arn(self, input: Option<String>) -> Self
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For Enhanced mode tasks, you must use /aws/datasync
as your log group name. For example:
arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*
For more information, see Monitoring data transfers with CloudWatch Logs.
Sourcepub fn get_cloud_watch_log_group_arn(&self) -> &Option<String>
pub fn get_cloud_watch_log_group_arn(&self) -> &Option<String>
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For Enhanced mode tasks, you must use /aws/datasync
as your log group name. For example:
arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*
For more information, see Monitoring data transfers with CloudWatch Logs.
Sourcepub fn includes(self, input: FilterRule) -> Self
pub fn includes(self, input: FilterRule) -> Self
Appends an item to Includes
.
To override the contents of this collection use set_includes
.
Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
Sourcepub fn set_includes(self, input: Option<Vec<FilterRule>>) -> Self
pub fn set_includes(self, input: Option<Vec<FilterRule>>) -> Self
Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
Sourcepub fn get_includes(&self) -> &Option<Vec<FilterRule>>
pub fn get_includes(&self) -> &Option<Vec<FilterRule>>
Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
Sourcepub fn manifest_config(self, input: ManifestConfig) -> Self
pub fn manifest_config(self, input: ManifestConfig) -> Self
Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a manifest configuration, specify this parameter as empty.
Sourcepub fn set_manifest_config(self, input: Option<ManifestConfig>) -> Self
pub fn set_manifest_config(self, input: Option<ManifestConfig>) -> Self
Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a manifest configuration, specify this parameter as empty.
Sourcepub fn get_manifest_config(&self) -> &Option<ManifestConfig>
pub fn get_manifest_config(&self) -> &Option<ManifestConfig>
Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.
When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a manifest configuration, specify this parameter as empty.
Sourcepub fn task_report_config(self, input: TaskReportConfig) -> Self
pub fn task_report_config(self, input: TaskReportConfig) -> Self
Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a task report configuration, specify this parameter as empty.
Sourcepub fn set_task_report_config(self, input: Option<TaskReportConfig>) -> Self
pub fn set_task_report_config(self, input: Option<TaskReportConfig>) -> Self
Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a task report configuration, specify this parameter as empty.
Sourcepub fn get_task_report_config(&self) -> &Option<TaskReportConfig>
pub fn get_task_report_config(&self) -> &Option<TaskReportConfig>
Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission.
To remove a task report configuration, specify this parameter as empty.
Trait Implementations§
Source§impl Clone for UpdateTaskFluentBuilder
impl Clone for UpdateTaskFluentBuilder
Source§fn clone(&self) -> UpdateTaskFluentBuilder
fn clone(&self) -> UpdateTaskFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateTaskFluentBuilder
impl !RefUnwindSafe for UpdateTaskFluentBuilder
impl Send for UpdateTaskFluentBuilder
impl Sync for UpdateTaskFluentBuilder
impl Unpin for UpdateTaskFluentBuilder
impl !UnwindSafe for UpdateTaskFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);