Struct aws_sdk_lexmodelsv2::input::list_aggregated_utterances_input::Builder

pub struct Builder { /* private fields */ }

A builder for ListAggregatedUtterancesInput.

Implementations

impl Builder

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

The unique identifier of the bot associated with this request.

Examples found in repository

src/client.rs (line 5604)

        pub fn bot_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.bot_id(input.into());
            self
        }

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

The unique identifier of the bot associated with this request.

Examples found in repository

src/client.rs (line 5609)

        pub fn set_bot_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_bot_id(input);
            self
        }

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

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

Examples found in repository

src/client.rs (line 5614)

        pub fn bot_alias_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.bot_alias_id(input.into());
            self
        }

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

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

Examples found in repository

src/client.rs (line 5619)

        pub fn set_bot_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_bot_alias_id(input);
            self
        }

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

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

Examples found in repository

src/client.rs (line 5624)

        pub fn bot_version(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.bot_version(input.into());
            self
        }

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

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

Examples found in repository

src/client.rs (line 5629)

        pub fn set_bot_version(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_bot_version(input);
            self
        }

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

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

Examples found in repository

src/client.rs (line 5634)

        pub fn locale_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.locale_id(input.into());
            self
        }

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

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

Examples found in repository

src/client.rs (line 5639)

        pub fn set_locale_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_locale_id(input);
            self
        }

pub fn aggregation_duration(self, input: UtteranceAggregationDuration) -> Self

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

Examples found in repository

src/client.rs (line 5647)

        pub fn aggregation_duration(
            mut self,
            input: crate::model::UtteranceAggregationDuration,
        ) -> Self {
            self.inner = self.inner.aggregation_duration(input);
            self
        }

pub fn set_aggregation_duration(
    self,
    input: Option<UtteranceAggregationDuration>
) -> Self

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

Examples found in repository

src/client.rs (line 5655)

        pub fn set_aggregation_duration(
            mut self,
            input: std::option::Option<crate::model::UtteranceAggregationDuration>,
        ) -> Self {
            self.inner = self.inner.set_aggregation_duration(input);
            self
        }

pub fn sort_by(self, input: AggregatedUtterancesSortBy) -> Self

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

Examples found in repository

src/client.rs (line 5660)

        pub fn sort_by(mut self, input: crate::model::AggregatedUtterancesSortBy) -> Self {
            self.inner = self.inner.sort_by(input);
            self
        }

pub fn set_sort_by(self, input: Option<AggregatedUtterancesSortBy>) -> Self

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

Examples found in repository

src/client.rs (line 5668)

        pub fn set_sort_by(
            mut self,
            input: std::option::Option<crate::model::AggregatedUtterancesSortBy>,
        ) -> Self {
            self.inner = self.inner.set_sort_by(input);
            self
        }

pub fn filters(self, input: AggregatedUtterancesFilter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Examples found in repository

src/client.rs (line 5677)

        pub fn filters(mut self, input: crate::model::AggregatedUtterancesFilter) -> Self {
            self.inner = self.inner.filters(input);
            self
        }

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

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Examples found in repository

src/client.rs (line 5685)

        pub fn set_filters(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::AggregatedUtterancesFilter>>,
        ) -> Self {
            self.inner = self.inner.set_filters(input);
            self
        }

pub fn max_results(self, input: i32) -> Self

The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.

Examples found in repository

src/client.rs (line 5690)

        pub fn max_results(mut self, input: i32) -> Self {
            self.inner = self.inner.max_results(input);
            self
        }

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.

Examples found in repository

src/client.rs (line 5695)

        pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_max_results(input);
            self
        }

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

If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Examples found in repository

src/client.rs (line 5700)

        pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.next_token(input.into());
            self
        }

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

If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Examples found in repository

src/client.rs (line 5705)

        pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_next_token(input);
            self
        }

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

Consumes the builder and constructs a ListAggregatedUtterancesInput.

Examples found in repository

src/client.rs (line 5565)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ListAggregatedUtterances,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ListAggregatedUtterancesError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::ListAggregatedUtterancesOutput,
            aws_smithy_http::result::SdkError<crate::error::ListAggregatedUtterancesError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

src/paginator.rs (line 60)

    pub fn send(
        self,
    ) -> impl tokio_stream::Stream<
        Item = std::result::Result<
            crate::output::ListAggregatedUtterancesOutput,
            aws_smithy_http::result::SdkError<crate::error::ListAggregatedUtterancesError>,
        >,
    > + Unpin {
        // Move individual fields out of self for the borrow checker
        let builder = self.builder;
        let handle = self.handle;
        aws_smithy_async::future::fn_stream::FnStream::new(move |tx| {
            Box::pin(async move {
                // Build the input for the first time. If required fields are missing, this is where we'll produce an early error.
                let mut input = match builder
                    .build()
                    .map_err(aws_smithy_http::result::SdkError::construction_failure)
                {
                    Ok(input) => input,
                    Err(e) => {
                        let _ = tx.send(Err(e)).await;
                        return;
                    }
                };
                loop {
                    let op = match input
                        .make_operation(&handle.conf)
                        .await
                        .map_err(aws_smithy_http::result::SdkError::construction_failure)
                    {
                        Ok(op) => op,
                        Err(e) => {
                            let _ = tx.send(Err(e)).await;
                            return;
                        }
                    };
                    let resp = handle.client.call(op).await;
                    // If the input member is None or it was an error
                    let done = match resp {
                        Ok(ref resp) => {
                            let new_token = crate::lens::reflens_structure_crate_output_list_aggregated_utterances_output_next_token(resp);
                            let is_empty = new_token.map(|token| token.is_empty()).unwrap_or(true);
                            if !is_empty
                                && new_token == input.next_token.as_ref()
                                && self.stop_on_duplicate_token
                            {
                                true
                            } else {
                                input.next_token = new_token.cloned();
                                is_empty
                            }
                        }
                        Err(_) => true,
                    };
                    if tx.send(resp).await.is_err() {
                        // receiving end was dropped
                        return;
                    }
                    if done {
                        return;
                    }
                }
            })
        })
    }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder