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

Interface ListAggregatedUtterancesRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListAggregatedUtterancesRequest

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

Method Summary

Modifier and Type	Method	Description
default ListAggregatedUtterancesRequest.Builder	aggregationDuration(Consumer<UtteranceAggregationDuration.Builder> aggregationDuration)	The time window for aggregating the utterance information.
ListAggregatedUtterancesRequest.Builder	aggregationDuration(UtteranceAggregationDuration aggregationDuration)	The time window for aggregating the utterance information.
ListAggregatedUtterancesRequest.Builder	botAliasId(String botAliasId)	The identifier of the bot alias associated with this request.
ListAggregatedUtterancesRequest.Builder	botId(String botId)	The unique identifier of the bot associated with this request.
ListAggregatedUtterancesRequest.Builder	botVersion(String botVersion)	The identifier of the bot version associated with this request.
ListAggregatedUtterancesRequest.Builder	filters(Collection<AggregatedUtterancesFilter> filters)	Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification.
ListAggregatedUtterancesRequest.Builder	filters(Consumer<AggregatedUtterancesFilter.Builder>... filters)	Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification.
ListAggregatedUtterancesRequest.Builder	filters(AggregatedUtterancesFilter... filters)	Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification.
ListAggregatedUtterancesRequest.Builder	localeId(String localeId)	The identifier of the language and locale where the utterances were collected.
ListAggregatedUtterancesRequest.Builder	maxResults(Integer maxResults)	The maximum number of utterances to return in each page of results.
ListAggregatedUtterancesRequest.Builder	nextToken(String nextToken)	If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response.
ListAggregatedUtterancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListAggregatedUtterancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default ListAggregatedUtterancesRequest.Builder	sortBy(Consumer<AggregatedUtterancesSortBy.Builder> sortBy)	Specifies sorting parameters for the list of utterances.
ListAggregatedUtterancesRequest.Builder	sortBy(AggregatedUtterancesSortBy sortBy)	Specifies sorting parameters for the list of utterances.

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

ListAggregatedUtterancesRequest.Builder botId(String botId)

The unique identifier of the bot associated with this request.

Parameters:

botId - The unique identifier of the bot associated with this request.

Returns:

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

botAliasId

ListAggregatedUtterancesRequest.Builder botAliasId(String botAliasId)

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

Parameters:

botAliasId - The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

Returns:

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

botVersion

ListAggregatedUtterancesRequest.Builder botVersion(String botVersion)

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

Parameters:

botVersion - The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

Returns:

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

localeId

ListAggregatedUtterancesRequest.Builder localeId(String localeId)

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

Parameters:

localeId - The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

Returns:

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

aggregationDuration

ListAggregatedUtterancesRequest.Builder aggregationDuration(UtteranceAggregationDuration aggregationDuration)

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

Parameters:

aggregationDuration - The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

Returns:

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

aggregationDuration

default ListAggregatedUtterancesRequest.Builder aggregationDuration(Consumer<UtteranceAggregationDuration.Builder> aggregationDuration)

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

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

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

Parameters:

aggregationDuration - a consumer that will call methods on UtteranceAggregationDuration.Builder

Returns:

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

See Also:

• aggregationDuration(UtteranceAggregationDuration)

sortBy

ListAggregatedUtterancesRequest.Builder sortBy(AggregatedUtterancesSortBy sortBy)

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

Parameters:

sortBy - Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

Returns:

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

sortBy

default ListAggregatedUtterancesRequest.Builder sortBy(Consumer<AggregatedUtterancesSortBy.Builder> sortBy)

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

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

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

Parameters:

sortBy - a consumer that will call methods on AggregatedUtterancesSortBy.Builder

Returns:

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

See Also:

• sortBy(AggregatedUtterancesSortBy)

filters

ListAggregatedUtterancesRequest.Builder filters(Collection<AggregatedUtterancesFilter> filters)

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Parameters:

filters - Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Returns:

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

filters

ListAggregatedUtterancesRequest.Builder filters(AggregatedUtterancesFilter... filters)

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Parameters:

filters - Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Returns:

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

filters

ListAggregatedUtterancesRequest.Builder filters(Consumer<AggregatedUtterancesFilter.Builder>... filters)

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

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

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

Parameters:

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

Returns:

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

See Also:

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

maxResults

ListAggregatedUtterancesRequest.Builder maxResults(Integer maxResults)

The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.

Parameters:

maxResults - The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.

Returns:

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

nextToken

ListAggregatedUtterancesRequest.Builder nextToken(String nextToken)

If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Parameters:

nextToken - If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Returns:

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

overrideConfiguration

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

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