pub struct ListSessionAnalyticsDataFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to ListSessionAnalyticsData.
Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:
-
Use the
filtersfield to filter the results and thesortByfield to specify the values by which to sort the results. -
Use the
maxResultsfield to limit the number of results to return in a single response and thenextTokenfield to return the next batch of results if the response does not return the full set of results.
Implementations§
Source§impl ListSessionAnalyticsDataFluentBuilder
impl ListSessionAnalyticsDataFluentBuilder
Sourcepub fn as_input(&self) -> &ListSessionAnalyticsDataInputBuilder
pub fn as_input(&self) -> &ListSessionAnalyticsDataInputBuilder
Access the ListSessionAnalyticsData as a reference.
Sourcepub async fn send(
self,
) -> Result<ListSessionAnalyticsDataOutput, SdkError<ListSessionAnalyticsDataError, HttpResponse>>
pub async fn send( self, ) -> Result<ListSessionAnalyticsDataOutput, SdkError<ListSessionAnalyticsDataError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<ListSessionAnalyticsDataOutput, ListSessionAnalyticsDataError, Self>
pub fn customize( self, ) -> CustomizableOperation<ListSessionAnalyticsDataOutput, ListSessionAnalyticsDataError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> ListSessionAnalyticsDataPaginator
pub fn into_paginator(self) -> ListSessionAnalyticsDataPaginator
Create a paginator for this request
Paginators are used by calling send().await which returns a PaginationStream.
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 analytics.
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 analytics.
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 analytics.
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 analytics.
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 analytics.
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 analytics.
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 analytics.
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 analytics.
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 analytics.
Sourcepub fn sort_by(self, input: SessionDataSortBy) -> Self
pub fn sort_by(self, input: SessionDataSortBy) -> Self
An object specifying the measure and method by which to sort the session analytics data.
Sourcepub fn set_sort_by(self, input: Option<SessionDataSortBy>) -> Self
pub fn set_sort_by(self, input: Option<SessionDataSortBy>) -> Self
An object specifying the measure and method by which to sort the session analytics data.
Sourcepub fn get_sort_by(&self) -> &Option<SessionDataSortBy>
pub fn get_sort_by(&self) -> &Option<SessionDataSortBy>
An object specifying the measure and method by which to sort the session analytics data.
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 ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData 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 ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData 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 ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
Trait Implementations§
Source§impl Clone for ListSessionAnalyticsDataFluentBuilder
impl Clone for ListSessionAnalyticsDataFluentBuilder
Source§fn clone(&self) -> ListSessionAnalyticsDataFluentBuilder
fn clone(&self) -> ListSessionAnalyticsDataFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for ListSessionAnalyticsDataFluentBuilder
impl !RefUnwindSafe for ListSessionAnalyticsDataFluentBuilder
impl Send for ListSessionAnalyticsDataFluentBuilder
impl Sync for ListSessionAnalyticsDataFluentBuilder
impl Unpin for ListSessionAnalyticsDataFluentBuilder
impl !UnwindSafe for ListSessionAnalyticsDataFluentBuilder
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>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());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>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());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>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());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>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());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>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());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>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());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);