Interface ListAggregatedUtterancesResponse.Builder

    • Method Detail

      • botId

        ListAggregatedUtterancesResponse.Builder botId​(String botId)

        The identifier of the bot that contains the utterances.

        Parameters:
        botId - The identifier of the bot that contains the utterances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • botAliasId

        ListAggregatedUtterancesResponse.Builder botAliasId​(String botAliasId)

        The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.

        Parameters:
        botAliasId - The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • botVersion

        ListAggregatedUtterancesResponse.Builder botVersion​(String botVersion)

        The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.

        Parameters:
        botVersion - The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • localeId

        ListAggregatedUtterancesResponse.Builder localeId​(String localeId)

        The identifier of the language and locale that the utterances are in.

        Parameters:
        localeId - The identifier of the language and locale that the utterances are in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregationDuration

        ListAggregatedUtterancesResponse.Builder aggregationDuration​(UtteranceAggregationDuration aggregationDuration)

        The time period used to aggregate the utterance data.

        Parameters:
        aggregationDuration - The time period used to aggregate the utterance data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregationWindowStartTime

        ListAggregatedUtterancesResponse.Builder aggregationWindowStartTime​(Instant aggregationWindowStartTime)

        The date and time that the aggregation window begins. Only data collected after this time is returned in the results.

        Parameters:
        aggregationWindowStartTime - The date and time that the aggregation window begins. Only data collected after this time is returned in the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregationWindowEndTime

        ListAggregatedUtterancesResponse.Builder aggregationWindowEndTime​(Instant aggregationWindowEndTime)

        The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.

        Parameters:
        aggregationWindowEndTime - The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregationLastRefreshedDateTime

        ListAggregatedUtterancesResponse.Builder aggregationLastRefreshedDateTime​(Instant aggregationLastRefreshedDateTime)

        The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

        • Hours - for 1 hour time window, every half hour; otherwise every hour.

        • Days - every 6 hours

        • Weeks - for a one week time window, every 12 hours; otherwise, every day

        Parameters:
        aggregationLastRefreshedDateTime - The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

        • Hours - for 1 hour time window, every half hour; otherwise every hour.

        • Days - every 6 hours

        • Weeks - for a one week time window, every 12 hours; otherwise, every day

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregatedUtterancesSummaries

        ListAggregatedUtterancesResponse.Builder aggregatedUtterancesSummaries​(Collection<AggregatedUtterancesSummary> aggregatedUtterancesSummaries)

        Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.

        Parameters:
        aggregatedUtterancesSummaries - Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • aggregatedUtterancesSummaries

        ListAggregatedUtterancesResponse.Builder aggregatedUtterancesSummaries​(AggregatedUtterancesSummary... aggregatedUtterancesSummaries)

        Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.

        Parameters:
        aggregatedUtterancesSummaries - Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • nextToken

        ListAggregatedUtterancesResponse.Builder nextToken​(String nextToken)

        A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.

        Parameters:
        nextToken - A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.