Package software.amazon.awssdk.services.lexmodelsv2.model

Class ListAggregatedUtterancesResponse

    • Method Detail

      • botId

        public final String botId()

        The identifier of the bot that contains the utterances.

        Returns:
        The identifier of the bot that contains the utterances.

      • botAliasId

        public final 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.

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

      • botVersion

        public final String botVersion()

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

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

      • localeId

        public final String localeId()

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

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

      • aggregationDuration

        public final UtteranceAggregationDuration aggregationDuration()

        The time period used to aggregate the utterance data.

        Returns:
        The time period used to aggregate the utterance data.

      • aggregationWindowStartTime

        public final Instant aggregationWindowStartTime()

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

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

      • aggregationWindowEndTime

        public final 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.

        Returns:
        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.

      • aggregationLastRefreshedDateTime

        public final 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

        Returns:
        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

      • hasAggregatedUtterancesSummaries

        public final boolean hasAggregatedUtterancesSummaries()
        For responses, this returns true if the service returned a value for the AggregatedUtterancesSummaries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • aggregatedUtterancesSummaries

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAggregatedUtterancesSummaries() method.

        Returns:
        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.

      • nextToken

        public final 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object