com.amazonaws.services.lexmodelsv2.model

Class ListAggregatedUtterancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexmodelsv2.model.ListAggregatedUtterancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListAggregatedUtterancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListAggregatedUtterancesRequest()

Method Summary

Modifier and Type	Method and Description
ListAggregatedUtterancesRequest	clone()
boolean	equals(Object obj)
UtteranceAggregationDuration	getAggregationDuration() The time window for aggregating the utterance information.
String	getBotAliasId() The identifier of the bot alias associated with this request.
String	getBotId() The unique identifier of the bot associated with this request.
String	getBotVersion() The identifier of the bot version associated with this request.
List<AggregatedUtterancesFilter>	getFilters() Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification.
String	getLocaleId() The identifier of the language and locale where the utterances were collected.
Integer	getMaxResults() The maximum number of utterances to return in each page of results.
String	getNextToken() If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response.
AggregatedUtterancesSortBy	getSortBy() Specifies sorting parameters for the list of utterances.
int	hashCode()
void	setAggregationDuration(UtteranceAggregationDuration aggregationDuration) The time window for aggregating the utterance information.
void	setBotAliasId(String botAliasId) The identifier of the bot alias associated with this request.
void	setBotId(String botId) The unique identifier of the bot associated with this request.
void	setBotVersion(String botVersion) The identifier of the bot version associated with this request.
void	setFilters(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.
void	setLocaleId(String localeId) The identifier of the language and locale where the utterances were collected.
void	setMaxResults(Integer maxResults) The maximum number of utterances to return in each page of results.
void	setNextToken(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.
void	setSortBy(AggregatedUtterancesSortBy sortBy) Specifies sorting parameters for the list of utterances.
String	toString() Returns a string representation of this object.
ListAggregatedUtterancesRequest	withAggregationDuration(UtteranceAggregationDuration aggregationDuration) The time window for aggregating the utterance information.
ListAggregatedUtterancesRequest	withBotAliasId(String botAliasId) The identifier of the bot alias associated with this request.
ListAggregatedUtterancesRequest	withBotId(String botId) The unique identifier of the bot associated with this request.
ListAggregatedUtterancesRequest	withBotVersion(String botVersion) The identifier of the bot version associated with this request.
ListAggregatedUtterancesRequest	withFilters(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	withFilters(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	withLocaleId(String localeId) The identifier of the language and locale where the utterances were collected.
ListAggregatedUtterancesRequest	withMaxResults(Integer maxResults) The maximum number of utterances to return in each page of results.
ListAggregatedUtterancesRequest	withNextToken(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	withSortBy(AggregatedUtterancesSortBy sortBy) Specifies sorting parameters for the list of utterances.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListAggregatedUtterancesRequest

public ListAggregatedUtterancesRequest()

Method Detail

setBotId

public void setBotId(String botId)

The unique identifier of the bot associated with this request.

Parameters:

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

getBotId

public String getBotId()

The unique identifier of the bot associated with this request.

Returns:

The unique identifier of the bot associated with this request.

withBotId

public ListAggregatedUtterancesRequest withBotId(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.

setBotAliasId

public void setBotAliasId(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.

getBotAliasId

public String getBotAliasId()

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

Returns:

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

withBotAliasId

public ListAggregatedUtterancesRequest withBotAliasId(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.

setBotVersion

public void setBotVersion(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.

getBotVersion

public String getBotVersion()

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

Returns:

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

withBotVersion

public ListAggregatedUtterancesRequest withBotVersion(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.

setLocaleId

public void setLocaleId(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.

getLocaleId

public String getLocaleId()

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

Returns:

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

withLocaleId

public ListAggregatedUtterancesRequest withLocaleId(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.

setAggregationDuration

public void setAggregationDuration(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.

getAggregationDuration

public UtteranceAggregationDuration getAggregationDuration()

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

Returns:

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

withAggregationDuration

public ListAggregatedUtterancesRequest withAggregationDuration(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.

setSortBy

public void setSortBy(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.

getSortBy

public AggregatedUtterancesSortBy getSortBy()

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:

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.

withSortBy

public ListAggregatedUtterancesRequest withSortBy(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.

getFilters

public List<AggregatedUtterancesFilter> getFilters()

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:

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.

setFilters

public void setFilters(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.

withFilters

public ListAggregatedUtterancesRequest withFilters(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.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

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.

withFilters

public ListAggregatedUtterancesRequest withFilters(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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:

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.

withMaxResults

public ListAggregatedUtterancesRequest withMaxResults(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.

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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:

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.

withNextToken

public ListAggregatedUtterancesRequest withNextToken(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListAggregatedUtterancesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest