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

Interface ListUtteranceAnalyticsDataRequest.Builder

    • Method Detail

      • botId

        ListUtteranceAnalyticsDataRequest.Builder botId​(String botId)

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

        Parameters:
        botId - The identifier for the bot for which you want to retrieve utterance analytics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startDateTime

        ListUtteranceAnalyticsDataRequest.Builder startDateTime​(Instant startDateTime)

        The date and time that marks the beginning of the range of time for which you want to see utterance analytics.

        Parameters:
        startDateTime - The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endDateTime

        ListUtteranceAnalyticsDataRequest.Builder endDateTime​(Instant endDateTime)

        The date and time that marks the end of the range of time for which you want to see utterance analytics.

        Parameters:
        endDateTime - The date and time that marks the end of the range of time for which you want to see utterance analytics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sortBy

        ListUtteranceAnalyticsDataRequest.Builder sortBy​(UtteranceDataSortBy sortBy)

        An object specifying the measure and method by which to sort the utterance analytics data.

        Parameters:
        sortBy - An object specifying the measure and method by which to sort the utterance analytics data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        ListUtteranceAnalyticsDataRequest.Builder filters​(Collection<AnalyticsUtteranceFilter> filters)

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

        Parameters:
        filters - A list of objects, each of which describes a condition by which you want to filter the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        ListUtteranceAnalyticsDataRequest.Builder filters​(AnalyticsUtteranceFilter... filters)

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

        Parameters:
        filters - A list of objects, each of which describes a condition by which you want to filter the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListUtteranceAnalyticsDataRequest.Builder maxResults​(Integer maxResults)

        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.

        Parameters:
        maxResults - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListUtteranceAnalyticsDataRequest.Builder nextToken​(String nextToken)

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

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

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