com.amazonaws.services.lexmodelsv2.model

Class ListUtteranceMetricsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexmodelsv2.model.ListUtteranceMetricsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListUtteranceMetricsRequest
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
ListUtteranceMetricsRequest()

Method Summary

Modifier and Type	Method and Description
ListUtteranceMetricsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AnalyticsUtteranceAttribute>	getAttributes() A list containing attributes related to the utterance that you want the response to return.
List<AnalyticsBinBySpecification>	getBinBy() A list of objects, each of which contains specifications for organizing the results by time.
String	getBotId() The identifier for the bot for which you want to retrieve utterance metrics.
Date	getEndDateTime() The date and time that marks the end of the range of time for which you want to see utterance metrics.
List<AnalyticsUtteranceFilter>	getFilters() A list of objects, each of which describes a condition by which you want to filter the results.
List<AnalyticsUtteranceGroupBySpecification>	getGroupBy() A list of objects, each of which specifies how to group the results.
Integer	getMaxResults() The maximum number of results to return in each page of results.
List<AnalyticsUtteranceMetric>	getMetrics() 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.
String	getNextToken() If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Date	getStartDateTime() The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
int	hashCode()
void	setAttributes(Collection<AnalyticsUtteranceAttribute> attributes) A list containing attributes related to the utterance that you want the response to return.
void	setBinBy(Collection<AnalyticsBinBySpecification> binBy) A list of objects, each of which contains specifications for organizing the results by time.
void	setBotId(String botId) The identifier for the bot for which you want to retrieve utterance metrics.
void	setEndDateTime(Date endDateTime) The date and time that marks the end of the range of time for which you want to see utterance metrics.
void	setFilters(Collection<AnalyticsUtteranceFilter> filters) A list of objects, each of which describes a condition by which you want to filter the results.
void	setGroupBy(Collection<AnalyticsUtteranceGroupBySpecification> groupBy) A list of objects, each of which specifies how to group the results.
void	setMaxResults(Integer maxResults) The maximum number of results to return in each page of results.
void	setMetrics(Collection<AnalyticsUtteranceMetric> 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.
void	setNextToken(String nextToken) If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
void	setStartDateTime(Date startDateTime) The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
String	toString() Returns a string representation of this object.
ListUtteranceMetricsRequest	withAttributes(AnalyticsUtteranceAttribute... attributes) A list containing attributes related to the utterance that you want the response to return.
ListUtteranceMetricsRequest	withAttributes(Collection<AnalyticsUtteranceAttribute> attributes) A list containing attributes related to the utterance that you want the response to return.
ListUtteranceMetricsRequest	withBinBy(AnalyticsBinBySpecification... binBy) A list of objects, each of which contains specifications for organizing the results by time.
ListUtteranceMetricsRequest	withBinBy(Collection<AnalyticsBinBySpecification> binBy) A list of objects, each of which contains specifications for organizing the results by time.
ListUtteranceMetricsRequest	withBotId(String botId) The identifier for the bot for which you want to retrieve utterance metrics.
ListUtteranceMetricsRequest	withEndDateTime(Date endDateTime) The date and time that marks the end of the range of time for which you want to see utterance metrics.
ListUtteranceMetricsRequest	withFilters(AnalyticsUtteranceFilter... filters) A list of objects, each of which describes a condition by which you want to filter the results.
ListUtteranceMetricsRequest	withFilters(Collection<AnalyticsUtteranceFilter> filters) A list of objects, each of which describes a condition by which you want to filter the results.
ListUtteranceMetricsRequest	withGroupBy(AnalyticsUtteranceGroupBySpecification... groupBy) A list of objects, each of which specifies how to group the results.
ListUtteranceMetricsRequest	withGroupBy(Collection<AnalyticsUtteranceGroupBySpecification> groupBy) A list of objects, each of which specifies how to group the results.
ListUtteranceMetricsRequest	withMaxResults(Integer maxResults) The maximum number of results to return in each page of results.
ListUtteranceMetricsRequest	withMetrics(AnalyticsUtteranceMetric... 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.
ListUtteranceMetricsRequest	withMetrics(Collection<AnalyticsUtteranceMetric> 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.
ListUtteranceMetricsRequest	withNextToken(String nextToken) If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
ListUtteranceMetricsRequest	withStartDateTime(Date startDateTime) The date and time that marks the beginning of the range of time for which you want to see utterance metrics.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUtteranceMetricsRequest

public ListUtteranceMetricsRequest()

Method Detail

setBotId

public void setBotId(String botId)

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

Parameters:

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

getBotId

public String getBotId()

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

Returns:

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

withBotId

public ListUtteranceMetricsRequest withBotId(String botId)

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

Parameters:

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

Returns:

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

setStartDateTime

public void setStartDateTime(Date startDateTime)

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

Parameters:

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

getStartDateTime

public Date getStartDateTime()

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

Returns:

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

withStartDateTime

public ListUtteranceMetricsRequest withStartDateTime(Date startDateTime)

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

Parameters:

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

Returns:

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

setEndDateTime

public void setEndDateTime(Date endDateTime)

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

Parameters:

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

getEndDateTime

public Date getEndDateTime()

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

Returns:

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

withEndDateTime

public ListUtteranceMetricsRequest withEndDateTime(Date endDateTime)

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

Parameters:

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

Returns:

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

getMetrics

public List<AnalyticsUtteranceMetric> getMetrics()

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:

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.

setMetrics

public void setMetrics(Collection<AnalyticsUtteranceMetric> 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.

withMetrics

public ListUtteranceMetricsRequest withMetrics(AnalyticsUtteranceMetric... 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.

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

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.

withMetrics

public ListUtteranceMetricsRequest withMetrics(Collection<AnalyticsUtteranceMetric> 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.

getBinBy

public List<AnalyticsBinBySpecification> getBinBy()

A list of objects, each of which contains specifications for organizing the results by time.

Returns:

A list of objects, each of which contains specifications for organizing the results by time.

setBinBy

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

withBinBy

public ListUtteranceMetricsRequest withBinBy(AnalyticsBinBySpecification... binBy)

A list of objects, each of which contains specifications for organizing the results by time.

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

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.

withBinBy

public ListUtteranceMetricsRequest withBinBy(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.

getGroupBy

public List<AnalyticsUtteranceGroupBySpecification> getGroupBy()

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

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

Returns:

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

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

setGroupBy

public void setGroupBy(Collection<AnalyticsUtteranceGroupBySpecification> groupBy)

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

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible 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:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

withGroupBy

public ListUtteranceMetricsRequest withGroupBy(AnalyticsUtteranceGroupBySpecification... groupBy)

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

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

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

Parameters:

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

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible 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.

withGroupBy

public ListUtteranceMetricsRequest withGroupBy(Collection<AnalyticsUtteranceGroupBySpecification> groupBy)

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

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible 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:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible 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.

getAttributes

public List<AnalyticsUtteranceAttribute> getAttributes()

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

Returns:

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

setAttributes

public void setAttributes(Collection<AnalyticsUtteranceAttribute> attributes)

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

Parameters:

attributes - A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

withAttributes

public ListUtteranceMetricsRequest withAttributes(AnalyticsUtteranceAttribute... attributes)

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

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

Parameters:

attributes - A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

Returns:

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

withAttributes

public ListUtteranceMetricsRequest withAttributes(Collection<AnalyticsUtteranceAttribute> attributes)

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

Parameters:

attributes - A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

Returns:

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

getFilters

public List<AnalyticsUtteranceFilter> getFilters()

A list of objects, each of which describes a condition by which you want to filter the results.

Returns:

A list of objects, each of which describes a condition by which you want to filter the results.

setFilters

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

withFilters

public ListUtteranceMetricsRequest withFilters(AnalyticsUtteranceFilter... filters)

A list of objects, each of which describes a condition by which you want to filter the results.

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

withFilters

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

setMaxResults

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

getMaxResults

public Integer getMaxResults()

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:

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.

withMaxResults

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

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public ListUtteranceMetricsRequest withNextToken(String nextToken)

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

Parameters:

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

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 ListUtteranceMetricsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()