Interface ListUtteranceAnalyticsDataRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListUtteranceAnalyticsDataRequest

@Mutable
@NotThreadSafe
public static interface ListUtteranceAnalyticsDataRequest.Builder
extends LexModelsV2Request.Builder, SdkPojo, CopyableBuilder<ListUtteranceAnalyticsDataRequest.Builder,ListUtteranceAnalyticsDataRequest>

Method Summary

Modifier and Type	Method	Description
ListUtteranceAnalyticsDataRequest.Builder	botId(String botId)	The identifier for the bot for which you want to retrieve utterance analytics.
ListUtteranceAnalyticsDataRequest.Builder	endDateTime(Instant endDateTime)	The date and time that marks the end of the range of time for which you want to see utterance analytics.
ListUtteranceAnalyticsDataRequest.Builder	filters(Collection<AnalyticsUtteranceFilter> filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListUtteranceAnalyticsDataRequest.Builder	filters(Consumer<AnalyticsUtteranceFilter.Builder>... filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListUtteranceAnalyticsDataRequest.Builder	filters(AnalyticsUtteranceFilter... filters)	A list of objects, each of which describes a condition by which you want to filter the results.
ListUtteranceAnalyticsDataRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in each page of results.
ListUtteranceAnalyticsDataRequest.Builder	nextToken(String nextToken)	If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
ListUtteranceAnalyticsDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListUtteranceAnalyticsDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default ListUtteranceAnalyticsDataRequest.Builder	sortBy(Consumer<UtteranceDataSortBy.Builder> sortBy)	An object specifying the measure and method by which to sort the utterance analytics data.
ListUtteranceAnalyticsDataRequest.Builder	sortBy(UtteranceDataSortBy sortBy)	An object specifying the measure and method by which to sort the utterance analytics data.
ListUtteranceAnalyticsDataRequest.Builder	startDateTime(Instant startDateTime)	The date and time that marks the beginning of the range of time for which you want to see utterance analytics.

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, sdkFieldNameToField, sdkFields

Method Details

botId

ListUtteranceAnalyticsDataRequest.Builder botId(String botId)

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

Parameters:

botId - The identifier for the bot for which you want to retrieve utterance analytics.

Returns:

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

startDateTime

ListUtteranceAnalyticsDataRequest.Builder startDateTime(Instant startDateTime)

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

Parameters:

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

Returns:

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

endDateTime

ListUtteranceAnalyticsDataRequest.Builder endDateTime(Instant endDateTime)

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

Parameters:

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

Returns:

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

sortBy

ListUtteranceAnalyticsDataRequest.Builder sortBy(UtteranceDataSortBy sortBy)

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

Parameters:

sortBy - An object specifying the measure and method by which to sort the utterance analytics data.

Returns:

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

sortBy

default ListUtteranceAnalyticsDataRequest.Builder sortBy(Consumer<UtteranceDataSortBy.Builder> sortBy)

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

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

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

Parameters:

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

Returns:

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

See Also:

• sortBy(UtteranceDataSortBy)

filters

ListUtteranceAnalyticsDataRequest.Builder filters(Collection<AnalyticsUtteranceFilter> 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

ListUtteranceAnalyticsDataRequest.Builder filters(AnalyticsUtteranceFilter... 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

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

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

Parameters:

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

Returns:

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

See Also:

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

maxResults

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

ListUtteranceAnalyticsDataRequest.Builder nextToken(String nextToken)

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

Parameters:

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

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

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