#[non_exhaustive]pub struct ManagedNotificationEventSummary {
pub schema_version: SchemaVersion,
pub source_event_metadata: Option<ManagedSourceEventMetadataSummary>,
pub message_components: Option<MessageComponentsSummary>,
pub event_status: EventStatus,
pub notification_type: NotificationType,
}
Expand description
A short summary of a ManagedNotificationEvent
. This is only used when listing managed notification events.
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.schema_version: SchemaVersion
The schema version of the ManagedNotificationEvent
.
source_event_metadata: Option<ManagedSourceEventMetadataSummary>
Contains metadata about the event that caused the ManagedNotificationEvent
.
message_components: Option<MessageComponentsSummary>
Contains the headline message component.
event_status: EventStatus
The managed notification event status.
-
Values:
-
HEALTHY
-
All
EventRules
areACTIVE
.
-
-
UNHEALTHY
-
Some
EventRules
areACTIVE
and some areINACTIVE
.
-
-
notification_type: NotificationType
The Type of event causing the notification.
-
Values:
-
ALERT
-
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
-
-
WARNING
-
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
-
-
ANNOUNCEMENT
-
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
-
-
INFORMATIONAL
-
A notification about informational messages. For example, recommendations, service announcements, or reminders.
-
-
Implementations§
Source§impl ManagedNotificationEventSummary
impl ManagedNotificationEventSummary
Sourcepub fn schema_version(&self) -> &SchemaVersion
pub fn schema_version(&self) -> &SchemaVersion
The schema version of the ManagedNotificationEvent
.
Sourcepub fn source_event_metadata(
&self,
) -> Option<&ManagedSourceEventMetadataSummary>
pub fn source_event_metadata( &self, ) -> Option<&ManagedSourceEventMetadataSummary>
Contains metadata about the event that caused the ManagedNotificationEvent
.
Sourcepub fn message_components(&self) -> Option<&MessageComponentsSummary>
pub fn message_components(&self) -> Option<&MessageComponentsSummary>
Contains the headline message component.
Sourcepub fn event_status(&self) -> &EventStatus
pub fn event_status(&self) -> &EventStatus
The managed notification event status.
-
Values:
-
HEALTHY
-
All
EventRules
areACTIVE
.
-
-
UNHEALTHY
-
Some
EventRules
areACTIVE
and some areINACTIVE
.
-
-
Sourcepub fn notification_type(&self) -> &NotificationType
pub fn notification_type(&self) -> &NotificationType
The Type of event causing the notification.
-
Values:
-
ALERT
-
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
-
-
WARNING
-
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
-
-
ANNOUNCEMENT
-
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
-
-
INFORMATIONAL
-
A notification about informational messages. For example, recommendations, service announcements, or reminders.
-
-
Source§impl ManagedNotificationEventSummary
impl ManagedNotificationEventSummary
Sourcepub fn builder() -> ManagedNotificationEventSummaryBuilder
pub fn builder() -> ManagedNotificationEventSummaryBuilder
Creates a new builder-style object to manufacture ManagedNotificationEventSummary
.
Trait Implementations§
Source§impl Clone for ManagedNotificationEventSummary
impl Clone for ManagedNotificationEventSummary
Source§fn clone(&self) -> ManagedNotificationEventSummary
fn clone(&self) -> ManagedNotificationEventSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for ManagedNotificationEventSummary
impl PartialEq for ManagedNotificationEventSummary
Source§fn eq(&self, other: &ManagedNotificationEventSummary) -> bool
fn eq(&self, other: &ManagedNotificationEventSummary) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ManagedNotificationEventSummary
Auto Trait Implementations§
impl Freeze for ManagedNotificationEventSummary
impl RefUnwindSafe for ManagedNotificationEventSummary
impl Send for ManagedNotificationEventSummary
impl Sync for ManagedNotificationEventSummary
impl Unpin for ManagedNotificationEventSummary
impl UnwindSafe for ManagedNotificationEventSummary
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);