#[non_exhaustive]pub struct DescribeTaskOutput {Show 20 fields
pub task_arn: Option<String>,
pub status: Option<TaskStatus>,
pub name: Option<String>,
pub current_task_execution_arn: Option<String>,
pub source_location_arn: Option<String>,
pub destination_location_arn: Option<String>,
pub cloud_watch_log_group_arn: Option<String>,
pub source_network_interface_arns: Option<Vec<String>>,
pub destination_network_interface_arns: Option<Vec<String>>,
pub options: Option<Options>,
pub excludes: Option<Vec<FilterRule>>,
pub schedule: Option<TaskSchedule>,
pub error_code: Option<String>,
pub error_detail: Option<String>,
pub creation_time: Option<DateTime>,
pub includes: Option<Vec<FilterRule>>,
pub manifest_config: Option<ManifestConfig>,
pub task_report_config: Option<TaskReportConfig>,
pub schedule_details: Option<TaskScheduleDetails>,
pub task_mode: Option<TaskMode>,
/* private fields */
}
Expand description
DescribeTaskResponse
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.task_arn: Option<String>
The ARN of your task.
status: Option<TaskStatus>
The status of your task. For information about what each status means, see Task statuses.
name: Option<String>
The name of your task.
current_task_execution_arn: Option<String>
The ARN of the most recent task execution.
source_location_arn: Option<String>
The ARN of your transfer's source location.
destination_location_arn: Option<String>
The ARN of your transfer's destination location.
cloud_watch_log_group_arn: Option<String>
The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For more information, see Monitoring data transfers with CloudWatch Logs.
source_network_interface_arns: Option<Vec<String>>
The ARNs of the network interfaces that DataSync created for your source location.
destination_network_interface_arns: Option<Vec<String>>
The ARNs of the network interfaces that DataSync created for your destination location.
options: Option<Options>
The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.
excludes: Option<Vec<FilterRule>>
The 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.
schedule: Option<TaskSchedule>
The schedule for when you want your task to run. For more information, see Scheduling your task.
error_code: Option<String>
If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
error_detail: Option<String>
If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
creation_time: Option<DateTime>
The time that the task was created.
includes: Option<Vec<FilterRule>>
The include filters that 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.
manifest_config: Option<ManifestConfig>
The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
task_report_config: Option<TaskReportConfig>
The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
schedule_details: Option<TaskScheduleDetails>
The details about your task schedule.
task_mode: Option<TaskMode>
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
Implementations§
Source§impl DescribeTaskOutput
impl DescribeTaskOutput
Sourcepub fn status(&self) -> Option<&TaskStatus>
pub fn status(&self) -> Option<&TaskStatus>
The status of your task. For information about what each status means, see Task statuses.
Sourcepub fn current_task_execution_arn(&self) -> Option<&str>
pub fn current_task_execution_arn(&self) -> Option<&str>
The ARN of the most recent task execution.
Sourcepub fn source_location_arn(&self) -> Option<&str>
pub fn source_location_arn(&self) -> Option<&str>
The ARN of your transfer's source location.
Sourcepub fn destination_location_arn(&self) -> Option<&str>
pub fn destination_location_arn(&self) -> Option<&str>
The ARN of your transfer's destination location.
Sourcepub fn cloud_watch_log_group_arn(&self) -> Option<&str>
pub fn cloud_watch_log_group_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For more information, see Monitoring data transfers with CloudWatch Logs.
Sourcepub fn source_network_interface_arns(&self) -> &[String]
pub fn source_network_interface_arns(&self) -> &[String]
The ARNs of the network interfaces that DataSync created for your source location.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_network_interface_arns.is_none()
.
Sourcepub fn destination_network_interface_arns(&self) -> &[String]
pub fn destination_network_interface_arns(&self) -> &[String]
The ARNs of the network interfaces that DataSync created for your destination location.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destination_network_interface_arns.is_none()
.
Sourcepub fn options(&self) -> Option<&Options>
pub fn options(&self) -> Option<&Options>
The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.
Sourcepub fn excludes(&self) -> &[FilterRule]
pub fn excludes(&self) -> &[FilterRule]
The 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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .excludes.is_none()
.
Sourcepub fn schedule(&self) -> Option<&TaskSchedule>
pub fn schedule(&self) -> Option<&TaskSchedule>
The schedule for when you want your task to run. For more information, see Scheduling your task.
Sourcepub fn error_code(&self) -> Option<&str>
pub fn error_code(&self) -> Option<&str>
If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
Sourcepub fn error_detail(&self) -> Option<&str>
pub fn error_detail(&self) -> Option<&str>
If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The time that the task was created.
Sourcepub fn includes(&self) -> &[FilterRule]
pub fn includes(&self) -> &[FilterRule]
The include filters that 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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .includes.is_none()
.
Sourcepub fn manifest_config(&self) -> Option<&ManifestConfig>
pub fn manifest_config(&self) -> Option<&ManifestConfig>
The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
Sourcepub fn task_report_config(&self) -> Option<&TaskReportConfig>
pub fn task_report_config(&self) -> Option<&TaskReportConfig>
The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
Sourcepub fn schedule_details(&self) -> Option<&TaskScheduleDetails>
pub fn schedule_details(&self) -> Option<&TaskScheduleDetails>
The details about your task schedule.
Sourcepub fn task_mode(&self) -> Option<&TaskMode>
pub fn task_mode(&self) -> Option<&TaskMode>
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
Source§impl DescribeTaskOutput
impl DescribeTaskOutput
Sourcepub fn builder() -> DescribeTaskOutputBuilder
pub fn builder() -> DescribeTaskOutputBuilder
Creates a new builder-style object to manufacture DescribeTaskOutput
.
Trait Implementations§
Source§impl Clone for DescribeTaskOutput
impl Clone for DescribeTaskOutput
Source§fn clone(&self) -> DescribeTaskOutput
fn clone(&self) -> DescribeTaskOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribeTaskOutput
impl Debug for DescribeTaskOutput
Source§impl PartialEq for DescribeTaskOutput
impl PartialEq for DescribeTaskOutput
Source§impl RequestId for DescribeTaskOutput
impl RequestId for DescribeTaskOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeTaskOutput
Auto Trait Implementations§
impl Freeze for DescribeTaskOutput
impl RefUnwindSafe for DescribeTaskOutput
impl Send for DescribeTaskOutput
impl Sync for DescribeTaskOutput
impl Unpin for DescribeTaskOutput
impl UnwindSafe for DescribeTaskOutput
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);