#[non_exhaustive]pub struct NotificationEventSummaryBuilder { /* private fields */ }
Expand description
A builder for NotificationEventSummary
.
Implementations§
Source§impl NotificationEventSummaryBuilder
impl NotificationEventSummaryBuilder
Sourcepub fn schema_version(self, input: SchemaVersion) -> Self
pub fn schema_version(self, input: SchemaVersion) -> Self
The schema version of the Notification Event.
This field is required.Sourcepub fn set_schema_version(self, input: Option<SchemaVersion>) -> Self
pub fn set_schema_version(self, input: Option<SchemaVersion>) -> Self
The schema version of the Notification Event.
Sourcepub fn get_schema_version(&self) -> &Option<SchemaVersion>
pub fn get_schema_version(&self) -> &Option<SchemaVersion>
The schema version of the Notification Event.
Sourcepub fn source_event_metadata(self, input: SourceEventMetadataSummary) -> Self
pub fn source_event_metadata(self, input: SourceEventMetadataSummary) -> Self
The source event metadata.
This field is required.Sourcepub fn set_source_event_metadata(
self,
input: Option<SourceEventMetadataSummary>,
) -> Self
pub fn set_source_event_metadata( self, input: Option<SourceEventMetadataSummary>, ) -> Self
The source event metadata.
Sourcepub fn get_source_event_metadata(&self) -> &Option<SourceEventMetadataSummary>
pub fn get_source_event_metadata(&self) -> &Option<SourceEventMetadataSummary>
The source event metadata.
Sourcepub fn message_components(self, input: MessageComponentsSummary) -> Self
pub fn message_components(self, input: MessageComponentsSummary) -> Self
The message components of a notification event.
This field is required.Sourcepub fn set_message_components(
self,
input: Option<MessageComponentsSummary>,
) -> Self
pub fn set_message_components( self, input: Option<MessageComponentsSummary>, ) -> Self
The message components of a notification event.
Sourcepub fn get_message_components(&self) -> &Option<MessageComponentsSummary>
pub fn get_message_components(&self) -> &Option<MessageComponentsSummary>
The message components of a notification event.
Sourcepub fn event_status(self, input: EventStatus) -> Self
pub fn event_status(self, input: EventStatus) -> Self
Provides additional information about the current status of the NotificationEvent
.
-
Values:
-
HEALTHY
-
All
EventRules
areACTIVE
.
-
-
UNHEALTHY
-
Some
EventRules
areACTIVE
and some areINACTIVE
.
-
-
Sourcepub fn set_event_status(self, input: Option<EventStatus>) -> Self
pub fn set_event_status(self, input: Option<EventStatus>) -> Self
Provides additional information about the current status of the NotificationEvent
.
-
Values:
-
HEALTHY
-
All
EventRules
areACTIVE
.
-
-
UNHEALTHY
-
Some
EventRules
areACTIVE
and some areINACTIVE
.
-
-
Sourcepub fn get_event_status(&self) -> &Option<EventStatus>
pub fn get_event_status(&self) -> &Option<EventStatus>
Provides additional information about the current status of the NotificationEvent
.
-
Values:
-
HEALTHY
-
All
EventRules
areACTIVE
.
-
-
UNHEALTHY
-
Some
EventRules
areACTIVE
and some areINACTIVE
.
-
-
Sourcepub fn notification_type(self, input: NotificationType) -> Self
pub fn notification_type(self, input: NotificationType) -> Self
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.
-
-
Sourcepub fn set_notification_type(self, input: Option<NotificationType>) -> Self
pub fn set_notification_type(self, input: Option<NotificationType>) -> Self
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.
-
-
Sourcepub fn get_notification_type(&self) -> &Option<NotificationType>
pub fn get_notification_type(&self) -> &Option<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.
-
-
Sourcepub fn build(self) -> Result<NotificationEventSummary, BuildError>
pub fn build(self) -> Result<NotificationEventSummary, BuildError>
Consumes the builder and constructs a NotificationEventSummary
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for NotificationEventSummaryBuilder
impl Clone for NotificationEventSummaryBuilder
Source§fn clone(&self) -> NotificationEventSummaryBuilder
fn clone(&self) -> NotificationEventSummaryBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for NotificationEventSummaryBuilder
impl Default for NotificationEventSummaryBuilder
Source§fn default() -> NotificationEventSummaryBuilder
fn default() -> NotificationEventSummaryBuilder
Source§impl PartialEq for NotificationEventSummaryBuilder
impl PartialEq for NotificationEventSummaryBuilder
Source§fn eq(&self, other: &NotificationEventSummaryBuilder) -> bool
fn eq(&self, other: &NotificationEventSummaryBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for NotificationEventSummaryBuilder
Auto Trait Implementations§
impl Freeze for NotificationEventSummaryBuilder
impl RefUnwindSafe for NotificationEventSummaryBuilder
impl Send for NotificationEventSummaryBuilder
impl Sync for NotificationEventSummaryBuilder
impl Unpin for NotificationEventSummaryBuilder
impl UnwindSafe for NotificationEventSummaryBuilder
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);