AnalyticsUtteranceMetric (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexmodelsv2.model.AnalyticsUtteranceMetric

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalyticsUtteranceMetric
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyticsUtteranceMetric()

Constructors
Constructor and Description
`AnalyticsUtteranceMetric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyticsUtteranceMetric`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The metric for which you want to get utterance summary statistics.
`String`	`getOrder()` Specifies whether to sort the results in ascending or descending order.
`String`	`getStatistic()` The summary statistic to calculate.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The metric for which you want to get utterance summary statistics.
`void`	`setOrder(String order)` Specifies whether to sort the results in ascending or descending order.
`void`	`setStatistic(String statistic)` The summary statistic to calculate.
`String`	`toString()` Returns a string representation of this object.
`AnalyticsUtteranceMetric`	`withName(AnalyticsUtteranceMetricName name)` The metric for which you want to get utterance summary statistics.
`AnalyticsUtteranceMetric`	`withName(String name)` The metric for which you want to get utterance summary statistics.
`AnalyticsUtteranceMetric`	`withOrder(AnalyticsSortOrder order)` Specifies whether to sort the results in ascending or descending order.
`AnalyticsUtteranceMetric`	`withOrder(String order)` Specifies whether to sort the results in ascending or descending order.
`AnalyticsUtteranceMetric`	`withStatistic(AnalyticsMetricStatistic statistic)` The summary statistic to calculate.
`AnalyticsUtteranceMetric`	`withStatistic(String statistic)` The summary statistic to calculate.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalyticsUtteranceMetric
```
public AnalyticsUtteranceMetric()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The metric for which you want to get utterance summary statistics.
    - Count – The number of utterances.
    - Missed – The number of utterances that Amazon Lex failed to recognize.
    - Detected – The number of utterances that Amazon Lex managed to detect.
    - UtteranceTimestamp – The date and time of the utterance.
    Parameters:
    name - The metric for which you want to get utterance summary statistics.
    
    Count – The number of utterances.
    
    Missed – The number of utterances that Amazon Lex failed to recognize.
    
    Detected – The number of utterances that Amazon Lex managed to detect.
    
    UtteranceTimestamp – The date and time of the utterance.
    See Also:
    
    AnalyticsUtteranceMetricName
  - getName
```
public String getName()
```
    The metric for which you want to get utterance summary statistics.
    - Count – The number of utterances.
    - Missed – The number of utterances that Amazon Lex failed to recognize.
    - Detected – The number of utterances that Amazon Lex managed to detect.
    - UtteranceTimestamp – The date and time of the utterance.
    Returns:
    The metric for which you want to get utterance summary statistics.
    
    Count – The number of utterances.
    
    Missed – The number of utterances that Amazon Lex failed to recognize.
    
    Detected – The number of utterances that Amazon Lex managed to detect.
    
    UtteranceTimestamp – The date and time of the utterance.
    See Also:
    
    AnalyticsUtteranceMetricName
  - withName
```
public AnalyticsUtteranceMetric withName(String name)
```
    The metric for which you want to get utterance summary statistics.
    - Count – The number of utterances.
    - Missed – The number of utterances that Amazon Lex failed to recognize.
    - Detected – The number of utterances that Amazon Lex managed to detect.
    - UtteranceTimestamp – The date and time of the utterance.
    Parameters:
    name - The metric for which you want to get utterance summary statistics.
    
    Count – The number of utterances.
    
    Missed – The number of utterances that Amazon Lex failed to recognize.
    
    Detected – The number of utterances that Amazon Lex managed to detect.
    
    UtteranceTimestamp – The date and time of the utterance.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsUtteranceMetricName
  - withName
```
public AnalyticsUtteranceMetric withName(AnalyticsUtteranceMetricName name)
```
    The metric for which you want to get utterance summary statistics.
    - Count – The number of utterances.
    - Missed – The number of utterances that Amazon Lex failed to recognize.
    - Detected – The number of utterances that Amazon Lex managed to detect.
    - UtteranceTimestamp – The date and time of the utterance.
    Parameters:
    name - The metric for which you want to get utterance summary statistics.
    
    Count – The number of utterances.
    
    Missed – The number of utterances that Amazon Lex failed to recognize.
    
    Detected – The number of utterances that Amazon Lex managed to detect.
    
    UtteranceTimestamp – The date and time of the utterance.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsUtteranceMetricName
  - setStatistic
```
public void setStatistic(String statistic)
```
    The summary statistic to calculate.
    - Sum – The total count for the category you provide in name.
    - Average – The total count divided by the number of utterances in the category you provide in name.
    - Max – The highest count in the category you provide in name.
    Parameters:
    statistic - The summary statistic to calculate.
    
    Sum – The total count for the category you provide in name.
    
    Average – The total count divided by the number of utterances in the category you provide in name.
    
    Max – The highest count in the category you provide in name.
    See Also:
    
    AnalyticsMetricStatistic
  - getStatistic
```
public String getStatistic()
```
    The summary statistic to calculate.
    - Sum – The total count for the category you provide in name.
    - Average – The total count divided by the number of utterances in the category you provide in name.
    - Max – The highest count in the category you provide in name.
    Returns:
    The summary statistic to calculate.
    
    Sum – The total count for the category you provide in name.
    
    Average – The total count divided by the number of utterances in the category you provide in name.
    
    Max – The highest count in the category you provide in name.
    See Also:
    
    AnalyticsMetricStatistic
  - withStatistic
```
public AnalyticsUtteranceMetric withStatistic(String statistic)
```
    The summary statistic to calculate.
    - Sum – The total count for the category you provide in name.
    - Average – The total count divided by the number of utterances in the category you provide in name.
    - Max – The highest count in the category you provide in name.
    Parameters:
    statistic - The summary statistic to calculate.
    
    Sum – The total count for the category you provide in name.
    
    Average – The total count divided by the number of utterances in the category you provide in name.
    
    Max – The highest count in the category you provide in name.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsMetricStatistic
  - withStatistic
```
public AnalyticsUtteranceMetric withStatistic(AnalyticsMetricStatistic statistic)
```
    The summary statistic to calculate.
    - Sum – The total count for the category you provide in name.
    - Average – The total count divided by the number of utterances in the category you provide in name.
    - Max – The highest count in the category you provide in name.
    Parameters:
    statistic - The summary statistic to calculate.
    
    Sum – The total count for the category you provide in name.
    
    Average – The total count divided by the number of utterances in the category you provide in name.
    
    Max – The highest count in the category you provide in name.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsMetricStatistic
  - setOrder
```
public void setOrder(String order)
```
    Specifies whether to sort the results in ascending or descending order.
    
    Parameters:
    
    order - Specifies whether to sort the results in ascending or descending order.
    
    See Also:
    
    AnalyticsSortOrder
  - getOrder
```
public String getOrder()
```
    Specifies whether to sort the results in ascending or descending order.
    
    Returns:
    
    Specifies whether to sort the results in ascending or descending order.
    
    See Also:
    
    AnalyticsSortOrder
  - withOrder
```
public AnalyticsUtteranceMetric withOrder(String order)
```
    Specifies whether to sort the results in ascending or descending order.
    
    Parameters:
    
    order - Specifies whether to sort the results in ascending or descending order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsSortOrder
  - withOrder
```
public AnalyticsUtteranceMetric withOrder(AnalyticsSortOrder order)
```
    Specifies whether to sort the results in ascending or descending order.
    
    Parameters:
    
    order - Specifies whether to sort the results in ascending or descending order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsSortOrder
  - 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 AnalyticsUtteranceMetric clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class AnalyticsUtteranceMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyticsUtteranceMetric

Method Detail

setName

getName

withName

withName

setStatistic

getStatistic

withStatistic

withStatistic

setOrder

getOrder

withOrder

withOrder

toString

equals

hashCode

clone

marshall