Interface ListSessionAnalyticsDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListSessionAnalyticsDataRequest.Builder,ListSessionAnalyticsDataRequest>, LexModelsV2Request.Builder, SdkBuilder<ListSessionAnalyticsDataRequest.Builder,ListSessionAnalyticsDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListSessionAnalyticsDataRequest
public static interface ListSessionAnalyticsDataRequest.Builder extends LexModelsV2Request.Builder, SdkPojo, CopyableBuilder<ListSessionAnalyticsDataRequest.Builder,ListSessionAnalyticsDataRequest>

  • Method Details

    • botId

      ListSessionAnalyticsDataRequest.Builder botId(String botId)

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

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

    • startDateTime

      ListSessionAnalyticsDataRequest.Builder startDateTime(Instant startDateTime)

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

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

    • endDateTime

      ListSessionAnalyticsDataRequest.Builder endDateTime(Instant endDateTime)

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

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

    • sortBy

      ListSessionAnalyticsDataRequest.Builder sortBy(SessionDataSortBy sortBy)

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

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

    • sortBy

      default ListSessionAnalyticsDataRequest.Builder sortBy(Consumer<SessionDataSortBy.Builder> sortBy)

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

      This is a convenience method that creates an instance of the SessionDataSortBy.Builder avoiding the need to create one manually via SessionDataSortBy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortBy(SessionDataSortBy).

      Parameters:
      sortBy - a consumer that will call methods on SessionDataSortBy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filters

      ListSessionAnalyticsDataRequest.Builder filters(Collection<AnalyticsSessionFilter> 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

      ListSessionAnalyticsDataRequest.Builder filters(AnalyticsSessionFilter... 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

      ListSessionAnalyticsDataRequest.Builder filters(Consumer<AnalyticsSessionFilter.Builder>... filters)

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

      This is a convenience method that creates an instance of the AnalyticsSessionFilter.Builder avoiding the need to create one manually via AnalyticsSessionFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<AnalyticsSessionFilter>).

      Parameters:
      filters - a consumer that will call methods on AnalyticsSessionFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListSessionAnalyticsDataRequest.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

      ListSessionAnalyticsDataRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData 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.

    • overrideConfiguration

      ListSessionAnalyticsDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListSessionAnalyticsDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.