Interface ListSessionMetricsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListSessionMetricsRequest.Builder,
,ListSessionMetricsRequest> LexModelsV2Request.Builder
,SdkBuilder<ListSessionMetricsRequest.Builder,
,ListSessionMetricsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListSessionMetricsRequest
-
Method Summary
Modifier and TypeMethodDescriptionA list of objects, each of which contains specifications for organizing the results by time.binBy
(Consumer<AnalyticsBinBySpecification.Builder>... binBy) A list of objects, each of which contains specifications for organizing the results by time.binBy
(AnalyticsBinBySpecification... binBy) A list of objects, each of which contains specifications for organizing the results by time.The identifier for the bot for which you want to retrieve session metrics.endDateTime
(Instant endDateTime) The date and time that marks the end of the range of time for which you want to see session metrics.filters
(Collection<AnalyticsSessionFilter> filters) A list of objects, each of which describes a condition by which you want to filter the results.filters
(Consumer<AnalyticsSessionFilter.Builder>... filters) A list of objects, each of which describes a condition by which you want to filter the results.filters
(AnalyticsSessionFilter... filters) A list of objects, each of which describes a condition by which you want to filter the results.A list of objects, each of which specifies how to group the results.groupBy
(Consumer<AnalyticsSessionGroupBySpecification.Builder>... groupBy) A list of objects, each of which specifies how to group the results.groupBy
(AnalyticsSessionGroupBySpecification... groupBy) A list of objects, each of which specifies how to group the results.maxResults
(Integer maxResults) The maximum number of results to return in each page of results.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.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.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.If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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
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
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
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
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
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
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 theAnalyticsSessionMetric.Builder
avoiding the need to create one manually viaAnalyticsSessionMetric.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometrics(List<AnalyticsSessionMetric>)
.- Parameters:
metrics
- a consumer that will call methods onAnalyticsSessionMetric.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theAnalyticsBinBySpecification.Builder
avoiding the need to create one manually viaAnalyticsBinBySpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobinBy(List<AnalyticsBinBySpecification>)
.- Parameters:
binBy
- a consumer that will call methods onAnalyticsBinBySpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
AnalyticsSessionGroupBySpecification.Builder
avoiding the need to create one manually viaAnalyticsSessionGroupBySpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupBy(List<AnalyticsSessionGroupBySpecification>)
.- Parameters:
groupBy
- a consumer that will call methods onAnalyticsSessionGroupBySpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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
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 theAnalyticsSessionFilter.Builder
avoiding the need to create one manually viaAnalyticsSessionFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<AnalyticsSessionFilter>)
.- Parameters:
filters
- a consumer that will call methods onAnalyticsSessionFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-