#[non_exhaustive]pub struct InsightBuilder { /* private fields */ }
Expand description
A builder for Insight
.
Implementations§
Source§impl InsightBuilder
impl InsightBuilder
Sourcepub fn insight_id(self, input: impl Into<String>) -> Self
pub fn insight_id(self, input: impl Into<String>) -> Self
The unique identifier for the insight. For example, insight-12345678901234567
.
Sourcepub fn set_insight_id(self, input: Option<String>) -> Self
pub fn set_insight_id(self, input: Option<String>) -> Self
The unique identifier for the insight. For example, insight-12345678901234567
.
Sourcepub fn get_insight_id(&self) -> &Option<String>
pub fn get_insight_id(&self) -> &Option<String>
The unique identifier for the insight. For example, insight-12345678901234567
.
Sourcepub fn insight_type(self, input: impl Into<String>) -> Self
pub fn insight_type(self, input: impl Into<String>) -> Self
The type of insight. For example, HighDBLoad
, HighCPU
, or DominatingSQLs
.
Sourcepub fn set_insight_type(self, input: Option<String>) -> Self
pub fn set_insight_type(self, input: Option<String>) -> Self
The type of insight. For example, HighDBLoad
, HighCPU
, or DominatingSQLs
.
Sourcepub fn get_insight_type(&self) -> &Option<String>
pub fn get_insight_type(&self) -> &Option<String>
The type of insight. For example, HighDBLoad
, HighCPU
, or DominatingSQLs
.
Sourcepub fn context(self, input: ContextType) -> Self
pub fn context(self, input: ContextType) -> Self
Indicates if the insight is causal or correlated insight.
Sourcepub fn set_context(self, input: Option<ContextType>) -> Self
pub fn set_context(self, input: Option<ContextType>) -> Self
Indicates if the insight is causal or correlated insight.
Sourcepub fn get_context(&self) -> &Option<ContextType>
pub fn get_context(&self) -> &Option<ContextType>
Indicates if the insight is causal or correlated insight.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The start time of the insight. For example, 2018-10-30T00:00:00Z
.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The start time of the insight. For example, 2018-10-30T00:00:00Z
.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The start time of the insight. For example, 2018-10-30T00:00:00Z
.
Sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
The end time of the insight. For example, 2018-10-30T00:00:00Z
.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The end time of the insight. For example, 2018-10-30T00:00:00Z
.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The end time of the insight. For example, 2018-10-30T00:00:00Z
.
Sourcepub fn severity(self, input: Severity) -> Self
pub fn severity(self, input: Severity) -> Self
The severity of the insight. The values are: Low
, Medium
, or High
.
Sourcepub fn set_severity(self, input: Option<Severity>) -> Self
pub fn set_severity(self, input: Option<Severity>) -> Self
The severity of the insight. The values are: Low
, Medium
, or High
.
Sourcepub fn get_severity(&self) -> &Option<Severity>
pub fn get_severity(&self) -> &Option<Severity>
The severity of the insight. The values are: Low
, Medium
, or High
.
Sourcepub fn supporting_insights(self, input: Insight) -> Self
pub fn supporting_insights(self, input: Insight) -> Self
Appends an item to supporting_insights
.
To override the contents of this collection use set_supporting_insights
.
List of supporting insights that provide additional factors for the insight.
Sourcepub fn set_supporting_insights(self, input: Option<Vec<Insight>>) -> Self
pub fn set_supporting_insights(self, input: Option<Vec<Insight>>) -> Self
List of supporting insights that provide additional factors for the insight.
Sourcepub fn get_supporting_insights(&self) -> &Option<Vec<Insight>>
pub fn get_supporting_insights(&self) -> &Option<Vec<Insight>>
List of supporting insights that provide additional factors for the insight.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact
.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact
.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact
.
Sourcepub fn recommendations(self, input: Recommendation) -> Self
pub fn recommendations(self, input: Recommendation) -> Self
Appends an item to recommendations
.
To override the contents of this collection use set_recommendations
.
List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
.
Sourcepub fn set_recommendations(self, input: Option<Vec<Recommendation>>) -> Self
pub fn set_recommendations(self, input: Option<Vec<Recommendation>>) -> Self
List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
.
Sourcepub fn get_recommendations(&self) -> &Option<Vec<Recommendation>>
pub fn get_recommendations(&self) -> &Option<Vec<Recommendation>>
List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
.
Sourcepub fn insight_data(self, input: Data) -> Self
pub fn insight_data(self, input: Data) -> Self
Appends an item to insight_data
.
To override the contents of this collection use set_insight_data
.
List of data objects containing metrics and references from the time range while generating the insight.
Sourcepub fn set_insight_data(self, input: Option<Vec<Data>>) -> Self
pub fn set_insight_data(self, input: Option<Vec<Data>>) -> Self
List of data objects containing metrics and references from the time range while generating the insight.
Sourcepub fn get_insight_data(&self) -> &Option<Vec<Data>>
pub fn get_insight_data(&self) -> &Option<Vec<Data>>
List of data objects containing metrics and references from the time range while generating the insight.
Sourcepub fn baseline_data(self, input: Data) -> Self
pub fn baseline_data(self, input: Data) -> Self
Appends an item to baseline_data
.
To override the contents of this collection use set_baseline_data
.
Metric names and values from the timeframe used as baseline to generate the insight.
Sourcepub fn set_baseline_data(self, input: Option<Vec<Data>>) -> Self
pub fn set_baseline_data(self, input: Option<Vec<Data>>) -> Self
Metric names and values from the timeframe used as baseline to generate the insight.
Sourcepub fn get_baseline_data(&self) -> &Option<Vec<Data>>
pub fn get_baseline_data(&self) -> &Option<Vec<Data>>
Metric names and values from the timeframe used as baseline to generate the insight.
Trait Implementations§
Source§impl Clone for InsightBuilder
impl Clone for InsightBuilder
Source§fn clone(&self) -> InsightBuilder
fn clone(&self) -> InsightBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for InsightBuilder
impl Debug for InsightBuilder
Source§impl Default for InsightBuilder
impl Default for InsightBuilder
Source§fn default() -> InsightBuilder
fn default() -> InsightBuilder
Source§impl PartialEq for InsightBuilder
impl PartialEq for InsightBuilder
impl StructuralPartialEq for InsightBuilder
Auto Trait Implementations§
impl Freeze for InsightBuilder
impl RefUnwindSafe for InsightBuilder
impl Send for InsightBuilder
impl Sync for InsightBuilder
impl Unpin for InsightBuilder
impl UnwindSafe for InsightBuilder
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);