#[non_exhaustive]pub struct DetectMitigationActionsTaskSummary {
pub task_id: Option<String>,
pub task_status: Option<DetectMitigationActionsTaskStatus>,
pub task_start_time: Option<DateTime>,
pub task_end_time: Option<DateTime>,
pub target: Option<DetectMitigationActionsTaskTarget>,
pub violation_event_occurrence_range: Option<ViolationEventOccurrenceRange>,
pub only_active_violations_included: bool,
pub suppressed_alerts_included: bool,
pub actions_definition: Option<Vec<MitigationAction>>,
pub task_statistics: Option<DetectMitigationActionsTaskStatistics>,
}
Expand description
The summary of the mitigation action tasks.
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_id: Option<String>
The unique identifier of the task.
task_status: Option<DetectMitigationActionsTaskStatus>
The status of the task.
task_start_time: Option<DateTime>
The date the task started.
task_end_time: Option<DateTime>
The date the task ended.
target: Option<DetectMitigationActionsTaskTarget>
Specifies the ML Detect findings to which the mitigation actions are applied.
violation_event_occurrence_range: Option<ViolationEventOccurrenceRange>
Specifies the time period of which violation events occurred between.
only_active_violations_included: bool
Includes only active violations.
suppressed_alerts_included: bool
Includes suppressed alerts.
actions_definition: Option<Vec<MitigationAction>>
The definition of the actions.
task_statistics: Option<DetectMitigationActionsTaskStatistics>
The statistics of a mitigation action task.
Implementations§
Source§impl DetectMitigationActionsTaskSummary
impl DetectMitigationActionsTaskSummary
Sourcepub fn task_status(&self) -> Option<&DetectMitigationActionsTaskStatus>
pub fn task_status(&self) -> Option<&DetectMitigationActionsTaskStatus>
The status of the task.
Sourcepub fn task_start_time(&self) -> Option<&DateTime>
pub fn task_start_time(&self) -> Option<&DateTime>
The date the task started.
Sourcepub fn task_end_time(&self) -> Option<&DateTime>
pub fn task_end_time(&self) -> Option<&DateTime>
The date the task ended.
Sourcepub fn target(&self) -> Option<&DetectMitigationActionsTaskTarget>
pub fn target(&self) -> Option<&DetectMitigationActionsTaskTarget>
Specifies the ML Detect findings to which the mitigation actions are applied.
Sourcepub fn violation_event_occurrence_range(
&self,
) -> Option<&ViolationEventOccurrenceRange>
pub fn violation_event_occurrence_range( &self, ) -> Option<&ViolationEventOccurrenceRange>
Specifies the time period of which violation events occurred between.
Sourcepub fn only_active_violations_included(&self) -> bool
pub fn only_active_violations_included(&self) -> bool
Includes only active violations.
Sourcepub fn suppressed_alerts_included(&self) -> bool
pub fn suppressed_alerts_included(&self) -> bool
Includes suppressed alerts.
Sourcepub fn actions_definition(&self) -> &[MitigationAction]
pub fn actions_definition(&self) -> &[MitigationAction]
The definition of the actions.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions_definition.is_none()
.
Sourcepub fn task_statistics(&self) -> Option<&DetectMitigationActionsTaskStatistics>
pub fn task_statistics(&self) -> Option<&DetectMitigationActionsTaskStatistics>
The statistics of a mitigation action task.
Source§impl DetectMitigationActionsTaskSummary
impl DetectMitigationActionsTaskSummary
Sourcepub fn builder() -> DetectMitigationActionsTaskSummaryBuilder
pub fn builder() -> DetectMitigationActionsTaskSummaryBuilder
Creates a new builder-style object to manufacture DetectMitigationActionsTaskSummary
.
Trait Implementations§
Source§impl Clone for DetectMitigationActionsTaskSummary
impl Clone for DetectMitigationActionsTaskSummary
Source§fn clone(&self) -> DetectMitigationActionsTaskSummary
fn clone(&self) -> DetectMitigationActionsTaskSummary
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for DetectMitigationActionsTaskSummary
impl PartialEq for DetectMitigationActionsTaskSummary
Source§fn eq(&self, other: &DetectMitigationActionsTaskSummary) -> bool
fn eq(&self, other: &DetectMitigationActionsTaskSummary) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DetectMitigationActionsTaskSummary
Auto Trait Implementations§
impl Freeze for DetectMitigationActionsTaskSummary
impl RefUnwindSafe for DetectMitigationActionsTaskSummary
impl Send for DetectMitigationActionsTaskSummary
impl Sync for DetectMitigationActionsTaskSummary
impl Unpin for DetectMitigationActionsTaskSummary
impl UnwindSafe for DetectMitigationActionsTaskSummary
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);