Struct aws_sdk_lexmodelsv2::operation::list_utterance_metrics::builders::ListUtteranceMetricsInputBuilder

#[non_exhaustive]
pub struct ListUtteranceMetricsInputBuilder { /* private fields */ }

A builder for ListUtteranceMetricsInput.

Implementations

impl ListUtteranceMetricsInputBuilder

pub fn bot_id(self, input: impl Into<String>) -> Self

The identifier for the bot for which you want to retrieve utterance metrics.

This field is required.

pub fn set_bot_id(self, input: Option<String>) -> Self

The identifier for the bot for which you want to retrieve utterance metrics.

pub fn get_bot_id(&self) -> &Option<String>

The identifier for the bot for which you want to retrieve utterance metrics.

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 utterance metrics.

This field is required.

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 utterance metrics.

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 utterance metrics.

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 utterance metrics.

This field is required.

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 utterance metrics.

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 utterance metrics.

pub fn metrics(self, input: AnalyticsUtteranceMetric) -> 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.

pub fn set_metrics(self, input: Option<Vec<AnalyticsUtteranceMetric>>) -> 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.

pub fn get_metrics(&self) -> &Option<Vec<AnalyticsUtteranceMetric>>

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.

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.

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.

pub fn get_bin_by(&self) -> &Option<Vec<AnalyticsBinBySpecification>>

A list of objects, each of which contains specifications for organizing the results by time.

pub fn group_by(self, input: AnalyticsUtteranceGroupBySpecification) -> 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:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

pub fn set_group_by( self, input: Option<Vec<AnalyticsUtteranceGroupBySpecification>> ) -> Self

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

pub fn get_group_by( &self ) -> &Option<Vec<AnalyticsUtteranceGroupBySpecification>>

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

pub fn attributes(self, input: AnalyticsUtteranceAttribute) -> Self

Appends an item to attributes.

To override the contents of this collection use set_attributes.

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

pub fn set_attributes( self, input: Option<Vec<AnalyticsUtteranceAttribute>> ) -> Self

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

pub fn get_attributes(&self) -> &Option<Vec<AnalyticsUtteranceAttribute>>

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

pub fn filters(self, input: AnalyticsUtteranceFilter) -> 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.

pub fn set_filters(self, input: Option<Vec<AnalyticsUtteranceFilter>>) -> Self

A list of objects, each of which describes a condition by which you want to filter the results.

pub fn get_filters(&self) -> &Option<Vec<AnalyticsUtteranceFilter>>

A list of objects, each of which describes a condition by which you want to filter the results.

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.

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.

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.

pub fn next_token(self, input: impl Into<String>) -> Self

If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

pub fn set_next_token(self, input: Option<String>) -> Self

If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

pub fn get_next_token(&self) -> &Option<String>

If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

pub fn build(self) -> Result<ListUtteranceMetricsInput, BuildError>

Consumes the builder and constructs a ListUtteranceMetricsInput.

impl ListUtteranceMetricsInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ListUtteranceMetricsOutput, SdkError<ListUtteranceMetricsError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ListUtteranceMetricsInputBuilder

fn clone(&self) -> ListUtteranceMetricsInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListUtteranceMetricsInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListUtteranceMetricsInputBuilder

fn default() -> ListUtteranceMetricsInputBuilder

Returns the “default value” for a type.

impl PartialEq for ListUtteranceMetricsInputBuilder

fn eq(&self, other: &ListUtteranceMetricsInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListUtteranceMetricsInputBuilder