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

Interface ListIntentMetricsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListIntentMetricsRequest

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

Method Summary

Modifier and Type	Method	Description
ListIntentMetricsRequest.Builder	binBy(Collection<AnalyticsBinBySpecification> binBy)	A list of objects, each of which contains specifications for organizing the results by time.
ListIntentMetricsRequest.Builder	binBy(Consumer<AnalyticsBinBySpecification.Builder>... binBy)	A list of objects, each of which contains specifications for organizing the results by time.
ListIntentMetricsRequest.Builder	binBy(AnalyticsBinBySpecification... binBy)	A list of objects, each of which contains specifications for organizing the results by time.
ListIntentMetricsRequest.Builder	botId(String botId)	The identifier for the bot for which you want to retrieve intent metrics.
ListIntentMetricsRequest.Builder	endDateTime(Instant endDateTime)	The date and time that marks the end of the range of time for which you want to see intent metrics.
ListIntentMetricsRequest.Builder	filters(Collection<AnalyticsIntentFilter> filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListIntentMetricsRequest.Builder	filters(Consumer<AnalyticsIntentFilter.Builder>... filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListIntentMetricsRequest.Builder	filters(AnalyticsIntentFilter... filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListIntentMetricsRequest.Builder	groupBy(Collection<AnalyticsIntentGroupBySpecification> groupBy)	A list of objects, each of which specifies how to group the results.
ListIntentMetricsRequest.Builder	groupBy(Consumer<AnalyticsIntentGroupBySpecification.Builder>... groupBy)	A list of objects, each of which specifies how to group the results.
ListIntentMetricsRequest.Builder	groupBy(AnalyticsIntentGroupBySpecification... groupBy)	A list of objects, each of which specifies how to group the results.
ListIntentMetricsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in each page of results.
ListIntentMetricsRequest.Builder	metrics(Collection<AnalyticsIntentMetric> 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 order by which to organize the results.
ListIntentMetricsRequest.Builder	metrics(Consumer<AnalyticsIntentMetric.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 order by which to organize the results.
ListIntentMetricsRequest.Builder	metrics(AnalyticsIntentMetric... 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 order by which to organize the results.
ListIntentMetricsRequest.Builder	nextToken(String nextToken)	If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
ListIntentMetricsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListIntentMetricsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListIntentMetricsRequest.Builder	startDateTime(Instant startDateTime)	The timestamp that marks the beginning of the range of time for which you want to see intent 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

ListIntentMetricsRequest.Builder botId(String botId)

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

Parameters:

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

Returns:

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

startDateTime

ListIntentMetricsRequest.Builder startDateTime(Instant startDateTime)

The timestamp that marks the beginning of the range of time for which you want to see intent metrics.

Parameters:

startDateTime - The timestamp that marks the beginning of the range of time for which you want to see intent metrics.

Returns:

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

endDateTime

ListIntentMetricsRequest.Builder endDateTime(Instant endDateTime)

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

Parameters:

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

Returns:

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

metrics

ListIntentMetricsRequest.Builder metrics(Collection<AnalyticsIntentMetric> 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 order 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 order by which to organize the results.

Returns:

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

metrics

ListIntentMetricsRequest.Builder metrics(AnalyticsIntentMetric... 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 order 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 order by which to organize the results.

Returns:

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

metrics

ListIntentMetricsRequest.Builder metrics(Consumer<AnalyticsIntentMetric.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 order by which to organize the results.

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

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

Parameters:

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

Returns:

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

See Also:

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

binBy

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

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

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

ListIntentMetricsRequest.Builder groupBy(Collection<AnalyticsIntentGroupBySpecification> groupBy)

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

• IntentName – The name of the intent.

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

Parameters:

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

• IntentName – The name of the intent.

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

Returns:

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

groupBy

ListIntentMetricsRequest.Builder groupBy(AnalyticsIntentGroupBySpecification... groupBy)

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

• IntentName – The name of the intent.

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

Parameters:

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

• IntentName – The name of the intent.

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

Returns:

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

groupBy

ListIntentMetricsRequest.Builder groupBy(Consumer<AnalyticsIntentGroupBySpecification.Builder>... groupBy)

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

• IntentName – The name of the intent.

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

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

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

Parameters:

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

Returns:

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

See Also:

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

filters

ListIntentMetricsRequest.Builder filters(Collection<AnalyticsIntentFilter> 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

ListIntentMetricsRequest.Builder filters(AnalyticsIntentFilter... 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

ListIntentMetricsRequest.Builder filters(Consumer<AnalyticsIntentFilter.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 AnalyticsIntentFilter.Builder avoiding the need to create one manually via AnalyticsIntentFilter.builder().

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

Parameters:

filters - a consumer that will call methods on AnalyticsIntentFilter.Builder

Returns:

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

See Also:

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

maxResults

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

ListIntentMetricsRequest.Builder nextToken(String nextToken)

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

Parameters:

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

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

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