#[non_exhaustive]pub struct ChangeEventBuilder { /* private fields */ }
Expand description
A builder for ChangeEvent
.
Implementations§
Source§impl ChangeEventBuilder
impl ChangeEventBuilder
Sourcepub fn timestamp(self, input: DateTime) -> Self
pub fn timestamp(self, input: DateTime) -> Self
The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
This field is required.Sourcepub fn set_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_timestamp(self, input: Option<DateTime>) -> Self
The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
Sourcepub fn get_timestamp(&self) -> &Option<DateTime>
pub fn get_timestamp(&self) -> &Option<DateTime>
The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
Sourcepub fn account_id(self, input: impl Into<String>) -> Self
pub fn account_id(self, input: impl Into<String>) -> Self
The Amazon Web Services account ID where this change event occurred.
This field is required.Sourcepub fn set_account_id(self, input: Option<String>) -> Self
pub fn set_account_id(self, input: Option<String>) -> Self
The Amazon Web Services account ID where this change event occurred.
Sourcepub fn get_account_id(&self) -> &Option<String>
pub fn get_account_id(&self) -> &Option<String>
The Amazon Web Services account ID where this change event occurred.
Sourcepub fn region(self, input: impl Into<String>) -> Self
pub fn region(self, input: impl Into<String>) -> Self
The Amazon Web Services region where this change event occurred.
This field is required.Sourcepub fn set_region(self, input: Option<String>) -> Self
pub fn set_region(self, input: Option<String>) -> Self
The Amazon Web Services region where this change event occurred.
Sourcepub fn get_region(&self) -> &Option<String>
pub fn get_region(&self) -> &Option<String>
The Amazon Web Services region where this change event occurred.
Sourcepub fn entity(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn entity(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to entity
.
To override the contents of this collection use set_entity
.
The entity (service or resource) that was affected by this change event, including its key attributes.
Sourcepub fn set_entity(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_entity(self, input: Option<HashMap<String, String>>) -> Self
The entity (service or resource) that was affected by this change event, including its key attributes.
Sourcepub fn get_entity(&self) -> &Option<HashMap<String, String>>
pub fn get_entity(&self) -> &Option<HashMap<String, String>>
The entity (service or resource) that was affected by this change event, including its key attributes.
Sourcepub fn change_event_type(self, input: ChangeEventType) -> Self
pub fn change_event_type(self, input: ChangeEventType) -> Self
The type of change event that occurred, such as DEPLOYMENT
.
Sourcepub fn set_change_event_type(self, input: Option<ChangeEventType>) -> Self
pub fn set_change_event_type(self, input: Option<ChangeEventType>) -> Self
The type of change event that occurred, such as DEPLOYMENT
.
Sourcepub fn get_change_event_type(&self) -> &Option<ChangeEventType>
pub fn get_change_event_type(&self) -> &Option<ChangeEventType>
The type of change event that occurred, such as DEPLOYMENT
.
Sourcepub fn event_id(self, input: impl Into<String>) -> Self
pub fn event_id(self, input: impl Into<String>) -> Self
A unique identifier for this change event.
This field is required.Sourcepub fn set_event_id(self, input: Option<String>) -> Self
pub fn set_event_id(self, input: Option<String>) -> Self
A unique identifier for this change event.
Sourcepub fn get_event_id(&self) -> &Option<String>
pub fn get_event_id(&self) -> &Option<String>
A unique identifier for this change event.
Sourcepub fn user_name(self, input: impl Into<String>) -> Self
pub fn user_name(self, input: impl Into<String>) -> Self
The name of the user who initiated this change event, if available.
Sourcepub fn set_user_name(self, input: Option<String>) -> Self
pub fn set_user_name(self, input: Option<String>) -> Self
The name of the user who initiated this change event, if available.
Sourcepub fn get_user_name(&self) -> &Option<String>
pub fn get_user_name(&self) -> &Option<String>
The name of the user who initiated this change event, if available.
Sourcepub fn event_name(self, input: impl Into<String>) -> Self
pub fn event_name(self, input: impl Into<String>) -> Self
The name or description of this change event.
Sourcepub fn set_event_name(self, input: Option<String>) -> Self
pub fn set_event_name(self, input: Option<String>) -> Self
The name or description of this change event.
Sourcepub fn get_event_name(&self) -> &Option<String>
pub fn get_event_name(&self) -> &Option<String>
The name or description of this change event.
Sourcepub fn build(self) -> Result<ChangeEvent, BuildError>
pub fn build(self) -> Result<ChangeEvent, BuildError>
Consumes the builder and constructs a ChangeEvent
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ChangeEventBuilder
impl Clone for ChangeEventBuilder
Source§fn clone(&self) -> ChangeEventBuilder
fn clone(&self) -> ChangeEventBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ChangeEventBuilder
impl Debug for ChangeEventBuilder
Source§impl Default for ChangeEventBuilder
impl Default for ChangeEventBuilder
Source§fn default() -> ChangeEventBuilder
fn default() -> ChangeEventBuilder
Source§impl PartialEq for ChangeEventBuilder
impl PartialEq for ChangeEventBuilder
impl StructuralPartialEq for ChangeEventBuilder
Auto Trait Implementations§
impl Freeze for ChangeEventBuilder
impl RefUnwindSafe for ChangeEventBuilder
impl Send for ChangeEventBuilder
impl Sync for ChangeEventBuilder
impl Unpin for ChangeEventBuilder
impl UnwindSafe for ChangeEventBuilder
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);