AnalyticsIntentStageMetric (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalyticsIntentStageMetric
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 intent stages across the user sessions with the bot.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyticsIntentStageMetric()

Constructors
Constructor and Description
`AnalyticsIntentStageMetric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyticsIntentStageMetric`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The metric for which you want to get intent stage summary statistics.
`String`	`getOrder()` Specifies whether to sort the results in ascending or descending order of the summary statistic ( `value` in the response).
`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 intent stage summary statistics.
`void`	`setOrder(String order)` Specifies whether to sort the results in ascending or descending order of the summary statistic ( `value` in the response).
`void`	`setStatistic(String statistic)` The summary statistic to calculate.
`String`	`toString()` Returns a string representation of this object.
`AnalyticsIntentStageMetric`	`withName(AnalyticsIntentStageMetricName name)` The metric for which you want to get intent stage summary statistics.
`AnalyticsIntentStageMetric`	`withName(String name)` The metric for which you want to get intent stage summary statistics.
`AnalyticsIntentStageMetric`	`withOrder(AnalyticsSortOrder order)` Specifies whether to sort the results in ascending or descending order of the summary statistic ( `value` in the response).
`AnalyticsIntentStageMetric`	`withOrder(String order)` Specifies whether to sort the results in ascending or descending order of the summary statistic ( `value` in the response).
`AnalyticsIntentStageMetric`	`withStatistic(AnalyticsMetricStatistic statistic)` The summary statistic to calculate.
`AnalyticsIntentStageMetric`	`withStatistic(String statistic)` The summary statistic to calculate.

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

- Constructor Detail
  - AnalyticsIntentStageMetric
```
public AnalyticsIntentStageMetric()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    - Count – The number of times the intent stage occurred.
    - Success – The number of times the intent stage succeeded.
    - Failure – The number of times the intent stage failed.
    - Dropped – The number of times the user dropped the intent stage.
    - Retry – The number of times the bot tried to elicit a response from the user at this stage.
    Parameters:
    name - The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    
    Count – The number of times the intent stage occurred.
    
    Success – The number of times the intent stage succeeded.
    
    Failure – The number of times the intent stage failed.
    
    Dropped – The number of times the user dropped the intent stage.
    
    Retry – The number of times the bot tried to elicit a response from the user at this stage.
    See Also:
    
    AnalyticsIntentStageMetricName
  - getName
```
public String getName()
```
    The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    - Count – The number of times the intent stage occurred.
    - Success – The number of times the intent stage succeeded.
    - Failure – The number of times the intent stage failed.
    - Dropped – The number of times the user dropped the intent stage.
    - Retry – The number of times the bot tried to elicit a response from the user at this stage.
    Returns:
    The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    
    Count – The number of times the intent stage occurred.
    
    Success – The number of times the intent stage succeeded.
    
    Failure – The number of times the intent stage failed.
    
    Dropped – The number of times the user dropped the intent stage.
    
    Retry – The number of times the bot tried to elicit a response from the user at this stage.
    See Also:
    
    AnalyticsIntentStageMetricName
  - withName
```
public AnalyticsIntentStageMetric withName(String name)
```
    The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    - Count – The number of times the intent stage occurred.
    - Success – The number of times the intent stage succeeded.
    - Failure – The number of times the intent stage failed.
    - Dropped – The number of times the user dropped the intent stage.
    - Retry – The number of times the bot tried to elicit a response from the user at this stage.
    Parameters:
    name - The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    
    Count – The number of times the intent stage occurred.
    
    Success – The number of times the intent stage succeeded.
    
    Failure – The number of times the intent stage failed.
    
    Dropped – The number of times the user dropped the intent stage.
    
    Retry – The number of times the bot tried to elicit a response from the user at this stage.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsIntentStageMetricName
  - withName
```
public AnalyticsIntentStageMetric withName(AnalyticsIntentStageMetricName name)
```
    The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    - Count – The number of times the intent stage occurred.
    - Success – The number of times the intent stage succeeded.
    - Failure – The number of times the intent stage failed.
    - Dropped – The number of times the user dropped the intent stage.
    - Retry – The number of times the bot tried to elicit a response from the user at this stage.
    Parameters:
    name - The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
    
    Count – The number of times the intent stage occurred.
    
    Success – The number of times the intent stage succeeded.
    
    Failure – The number of times the intent stage failed.
    
    Dropped – The number of times the user dropped the intent stage.
    
    Retry – The number of times the bot tried to elicit a response from the user at this stage.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsIntentStageMetricName
  - 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 intent stages 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 intent stages 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 intent stages 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 intent stages in the category you provide in name.
    
    Max – The highest count in the category you provide in name.
    See Also:
    
    AnalyticsMetricStatistic
  - withStatistic
```
public AnalyticsIntentStageMetric 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 intent stages 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 intent stages 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 AnalyticsIntentStageMetric 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 intent stages 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 intent stages 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 of the summary statistic ( value in the response).
    
    Parameters:
    
    order - Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    See Also:
    
    AnalyticsSortOrder
  - getOrder
```
public String getOrder()
```
    Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    Returns:
    
    Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    See Also:
    
    AnalyticsSortOrder
  - withOrder
```
public AnalyticsIntentStageMetric withOrder(String order)
```
    Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    Parameters:
    
    order - Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsSortOrder
  - withOrder
```
public AnalyticsIntentStageMetric withOrder(AnalyticsSortOrder order)
```
    Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    Parameters:
    
    order - Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    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 AnalyticsIntentStageMetric 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.780

Class AnalyticsIntentStageMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyticsIntentStageMetric

Method Detail

setName

getName

withName

withName

setStatistic

getStatistic

withStatistic

withStatistic

setOrder

getOrder

withOrder

withOrder

toString

equals

hashCode

clone

marshall