Interface ListSessionMetricsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListSessionMetricsRequest.Builder,ListSessionMetricsRequest>, LexModelsV2Request.Builder, SdkBuilder<ListSessionMetricsRequest.Builder,ListSessionMetricsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListSessionMetricsRequest

public static interface ListSessionMetricsRequest.Builder
extends LexModelsV2Request.Builder, SdkPojo, CopyableBuilder<ListSessionMetricsRequest.Builder,ListSessionMetricsRequest>

Method Summary

Modifier and Type	Method	Description
ListSessionMetricsRequest.Builder	binBy(Collection<AnalyticsBinBySpecification> binBy)	A list of objects, each of which contains specifications for organizing the results by time.
ListSessionMetricsRequest.Builder	binBy(Consumer<AnalyticsBinBySpecification.Builder>... binBy)	A list of objects, each of which contains specifications for organizing the results by time.
ListSessionMetricsRequest.Builder	binBy(AnalyticsBinBySpecification... binBy)	A list of objects, each of which contains specifications for organizing the results by time.
ListSessionMetricsRequest.Builder	botId(String botId)	The identifier for the bot for which you want to retrieve session metrics.
ListSessionMetricsRequest.Builder	endDateTime(Instant endDateTime)	The date and time that marks the end of the range of time for which you want to see session metrics.
ListSessionMetricsRequest.Builder	filters(Collection<AnalyticsSessionFilter> filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListSessionMetricsRequest.Builder	filters(Consumer<AnalyticsSessionFilter.Builder>... filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListSessionMetricsRequest.Builder	filters(AnalyticsSessionFilter... filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListSessionMetricsRequest.Builder	groupBy(Collection<AnalyticsSessionGroupBySpecification> groupBy)	A list of objects, each of which specifies how to group the results.
ListSessionMetricsRequest.Builder	groupBy(Consumer<AnalyticsSessionGroupBySpecification.Builder>... groupBy)	A list of objects, each of which specifies how to group the results.
ListSessionMetricsRequest.Builder	groupBy(AnalyticsSessionGroupBySpecification... groupBy)	A list of objects, each of which specifies how to group the results.
ListSessionMetricsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in each page of results.
ListSessionMetricsRequest.Builder	metrics(Collection<AnalyticsSessionMetric> metrics)	A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
ListSessionMetricsRequest.Builder	metrics(Consumer<AnalyticsSessionMetric.Builder>... metrics)	A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
ListSessionMetricsRequest.Builder	metrics(AnalyticsSessionMetric... metrics)	A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
ListSessionMetricsRequest.Builder	nextToken(String nextToken)	If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
ListSessionMetricsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListSessionMetricsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListSessionMetricsRequest.Builder	startDateTime(Instant startDateTime)	The date and time that marks the beginning of the range of time for which you want to see session metrics.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

botId

ListSessionMetricsRequest.Builder botId(String botId)

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

Parameters:

botId - The identifier for the bot for which you want to retrieve session metrics.

Returns:

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

startDateTime

ListSessionMetricsRequest.Builder startDateTime(Instant startDateTime)

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

Parameters:

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

Returns:

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

endDateTime

ListSessionMetricsRequest.Builder endDateTime(Instant endDateTime)

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

Parameters:

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

Returns:

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

metrics

ListSessionMetricsRequest.Builder metrics(Collection<AnalyticsSessionMetric> metrics)

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Parameters:

metrics - A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Returns:

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

metrics

ListSessionMetricsRequest.Builder metrics(AnalyticsSessionMetric... metrics)

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Parameters:

metrics - A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

Returns:

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

metrics

ListSessionMetricsRequest.Builder metrics(Consumer<AnalyticsSessionMetric.Builder>... metrics)

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

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

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

Parameters:

metrics - a consumer that will call methods on AnalyticsSessionMetric.Builder

Returns:

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

See Also:

• metrics(java.util.Collection<AnalyticsSessionMetric>)

binBy

ListSessionMetricsRequest.Builder binBy(Collection<AnalyticsBinBySpecification> binBy)

A list of objects, each of which contains specifications for organizing the results by time.

Parameters:

binBy - A list of objects, each of which contains specifications for organizing the results by time.

Returns:

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

binBy

ListSessionMetricsRequest.Builder binBy(AnalyticsBinBySpecification... binBy)

A list of objects, each of which contains specifications for organizing the results by time.

Parameters:

binBy - A list of objects, each of which contains specifications for organizing the results by time.

Returns:

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

binBy

ListSessionMetricsRequest.Builder binBy(Consumer<AnalyticsBinBySpecification.Builder>... binBy)

A list of objects, each of which contains specifications for organizing the results by time.

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

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

Parameters:

binBy - a consumer that will call methods on AnalyticsBinBySpecification.Builder

Returns:

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

See Also:

• binBy(java.util.Collection<AnalyticsBinBySpecification>)

groupBy

ListSessionMetricsRequest.Builder groupBy(Collection<AnalyticsSessionGroupBySpecification> groupBy)

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Parameters:

groupBy - A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Returns:

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

groupBy

ListSessionMetricsRequest.Builder groupBy(AnalyticsSessionGroupBySpecification... groupBy)

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Parameters:

groupBy - A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

Returns:

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

groupBy

ListSessionMetricsRequest.Builder groupBy(Consumer<AnalyticsSessionGroupBySpecification.Builder>... groupBy)

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide.

• LocaleId – The unique identifier of the bot locale.

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

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

Parameters:

groupBy - a consumer that will call methods on AnalyticsSessionGroupBySpecification.Builder

Returns:

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

See Also:

• groupBy(java.util.Collection<AnalyticsSessionGroupBySpecification>)

filters

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

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

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

• filters(java.util.Collection<AnalyticsSessionFilter>)

maxResults

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

ListSessionMetricsRequest.Builder nextToken(String nextToken)

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

Parameters:

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

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

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