#[non_exhaustive]pub struct ListSessionMetricsInputBuilder { /* private fields */ }
Expand description
A builder for ListSessionMetricsInput
.
Implementations§
Source§impl ListSessionMetricsInputBuilder
impl ListSessionMetricsInputBuilder
Sourcepub fn bot_id(self, input: impl Into<String>) -> Self
pub fn bot_id(self, input: impl Into<String>) -> Self
The identifier for the bot for which you want to retrieve session metrics.
This field is required.Sourcepub fn set_bot_id(self, input: Option<String>) -> Self
pub fn set_bot_id(self, input: Option<String>) -> Self
The identifier for the bot for which you want to retrieve session metrics.
Sourcepub fn get_bot_id(&self) -> &Option<String>
pub fn get_bot_id(&self) -> &Option<String>
The identifier for the bot for which you want to retrieve session metrics.
Sourcepub fn start_date_time(self, input: DateTime) -> Self
pub fn start_date_time(self, input: DateTime) -> Self
The date and time that marks the beginning of the range of time for which you want to see session metrics.
This field is required.Sourcepub fn set_start_date_time(self, input: Option<DateTime>) -> Self
pub fn set_start_date_time(self, input: Option<DateTime>) -> Self
The date and time that marks the beginning of the range of time for which you want to see session metrics.
Sourcepub fn get_start_date_time(&self) -> &Option<DateTime>
pub fn get_start_date_time(&self) -> &Option<DateTime>
The date and time that marks the beginning of the range of time for which you want to see session metrics.
Sourcepub fn end_date_time(self, input: DateTime) -> Self
pub fn end_date_time(self, input: DateTime) -> Self
The date and time that marks the end of the range of time for which you want to see session metrics.
This field is required.Sourcepub fn set_end_date_time(self, input: Option<DateTime>) -> Self
pub fn set_end_date_time(self, input: Option<DateTime>) -> Self
The date and time that marks the end of the range of time for which you want to see session metrics.
Sourcepub fn get_end_date_time(&self) -> &Option<DateTime>
pub fn get_end_date_time(&self) -> &Option<DateTime>
The date and time that marks the end of the range of time for which you want to see session metrics.
Sourcepub fn metrics(self, input: AnalyticsSessionMetric) -> Self
pub fn metrics(self, input: AnalyticsSessionMetric) -> Self
Appends an item to metrics
.
To override the contents of this collection use set_metrics
.
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Sourcepub fn set_metrics(self, input: Option<Vec<AnalyticsSessionMetric>>) -> Self
pub fn set_metrics(self, input: Option<Vec<AnalyticsSessionMetric>>) -> Self
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Sourcepub fn get_metrics(&self) -> &Option<Vec<AnalyticsSessionMetric>>
pub fn get_metrics(&self) -> &Option<Vec<AnalyticsSessionMetric>>
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Sourcepub fn bin_by(self, input: AnalyticsBinBySpecification) -> Self
pub fn bin_by(self, input: AnalyticsBinBySpecification) -> Self
Appends an item to bin_by
.
To override the contents of this collection use set_bin_by
.
A list of objects, each of which contains specifications for organizing the results by time.
Sourcepub fn set_bin_by(self, input: Option<Vec<AnalyticsBinBySpecification>>) -> Self
pub fn set_bin_by(self, input: Option<Vec<AnalyticsBinBySpecification>>) -> Self
A list of objects, each of which contains specifications for organizing the results by time.
Sourcepub fn get_bin_by(&self) -> &Option<Vec<AnalyticsBinBySpecification>>
pub fn get_bin_by(&self) -> &Option<Vec<AnalyticsBinBySpecification>>
A list of objects, each of which contains specifications for organizing the results by time.
Sourcepub fn group_by(self, input: AnalyticsSessionGroupBySpecification) -> Self
pub fn group_by(self, input: AnalyticsSessionGroupBySpecification) -> Self
Appends an item to group_by
.
To override the contents of this collection use set_group_by
.
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
ConversationEndState
– The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. -
LocaleId
– The unique identifier of the bot locale.
Sourcepub fn set_group_by(
self,
input: Option<Vec<AnalyticsSessionGroupBySpecification>>,
) -> Self
pub fn set_group_by( self, input: Option<Vec<AnalyticsSessionGroupBySpecification>>, ) -> Self
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
ConversationEndState
– The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. -
LocaleId
– The unique identifier of the bot locale.
Sourcepub fn get_group_by(&self) -> &Option<Vec<AnalyticsSessionGroupBySpecification>>
pub fn get_group_by(&self) -> &Option<Vec<AnalyticsSessionGroupBySpecification>>
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
ConversationEndState
– The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. -
LocaleId
– The unique identifier of the bot locale.
Sourcepub fn filters(self, input: AnalyticsSessionFilter) -> Self
pub fn filters(self, input: AnalyticsSessionFilter) -> Self
Appends an item to filters
.
To override the contents of this collection use set_filters
.
A list of objects, each of which describes a condition by which you want to filter the results.
Sourcepub fn set_filters(self, input: Option<Vec<AnalyticsSessionFilter>>) -> Self
pub fn set_filters(self, input: Option<Vec<AnalyticsSessionFilter>>) -> Self
A list of objects, each of which describes a condition by which you want to filter the results.
Sourcepub fn get_filters(&self) -> &Option<Vec<AnalyticsSessionFilter>>
pub fn get_filters(&self) -> &Option<Vec<AnalyticsSessionFilter>>
A list of objects, each of which describes a condition by which you want to filter the results.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
Sourcepub fn build(self) -> Result<ListSessionMetricsInput, BuildError>
pub fn build(self) -> Result<ListSessionMetricsInput, BuildError>
Consumes the builder and constructs a ListSessionMetricsInput
.
Source§impl ListSessionMetricsInputBuilder
impl ListSessionMetricsInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ListSessionMetricsOutput, SdkError<ListSessionMetricsError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ListSessionMetricsOutput, SdkError<ListSessionMetricsError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ListSessionMetricsInputBuilder
impl Clone for ListSessionMetricsInputBuilder
Source§fn clone(&self) -> ListSessionMetricsInputBuilder
fn clone(&self) -> ListSessionMetricsInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ListSessionMetricsInputBuilder
impl Default for ListSessionMetricsInputBuilder
Source§fn default() -> ListSessionMetricsInputBuilder
fn default() -> ListSessionMetricsInputBuilder
Source§impl PartialEq for ListSessionMetricsInputBuilder
impl PartialEq for ListSessionMetricsInputBuilder
Source§fn eq(&self, other: &ListSessionMetricsInputBuilder) -> bool
fn eq(&self, other: &ListSessionMetricsInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ListSessionMetricsInputBuilder
Auto Trait Implementations§
impl Freeze for ListSessionMetricsInputBuilder
impl RefUnwindSafe for ListSessionMetricsInputBuilder
impl Send for ListSessionMetricsInputBuilder
impl Sync for ListSessionMetricsInputBuilder
impl Unpin for ListSessionMetricsInputBuilder
impl UnwindSafe for ListSessionMetricsInputBuilder
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);