AnalyticsSessionMetric (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyticsSessionMetric()

Constructors
Constructor and Description
`AnalyticsSessionMetric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyticsSessionMetric`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The metric for which you want to get session 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 session 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.
`AnalyticsSessionMetric`	`withName(AnalyticsSessionMetricName name)` The metric for which you want to get session summary statistics.
`AnalyticsSessionMetric`	`withName(String name)` The metric for which you want to get session summary statistics.
`AnalyticsSessionMetric`	`withOrder(AnalyticsSortOrder order)` Specifies whether to sort the results in ascending or descending order.
`AnalyticsSessionMetric`	`withOrder(String order)` Specifies whether to sort the results in ascending or descending order.
`AnalyticsSessionMetric`	`withStatistic(AnalyticsMetricStatistic statistic)` The summary statistic to calculate.
`AnalyticsSessionMetric`	`withStatistic(String statistic)` The summary statistic to calculate.

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

- Constructor Detail
  - AnalyticsSessionMetric
```
public AnalyticsSessionMetric()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The metric for which you want to get session summary statistics.
    - Count – The number of sessions.
    - Success – The number of sessions that succeeded.
    - Failure – The number of sessions that failed.
    - Dropped – The number of sessions that the user dropped.
    - Duration – The duration of sessions.
    - TurnsPerSession – The number of turns in the sessions.
    - Concurrency – The number of sessions occurring in the same period of time.
    Parameters:
    name - The metric for which you want to get session summary statistics.
    
    Count – The number of sessions.
    
    Success – The number of sessions that succeeded.
    
    Failure – The number of sessions that failed.
    
    Dropped – The number of sessions that the user dropped.
    
    Duration – The duration of sessions.
    
    TurnsPerSession – The number of turns in the sessions.
    
    Concurrency – The number of sessions occurring in the same period of time.
    See Also:
    
    AnalyticsSessionMetricName
  - getName
```
public String getName()
```
    The metric for which you want to get session summary statistics.
    - Count – The number of sessions.
    - Success – The number of sessions that succeeded.
    - Failure – The number of sessions that failed.
    - Dropped – The number of sessions that the user dropped.
    - Duration – The duration of sessions.
    - TurnsPerSession – The number of turns in the sessions.
    - Concurrency – The number of sessions occurring in the same period of time.
    Returns:
    The metric for which you want to get session summary statistics.
    
    Count – The number of sessions.
    
    Success – The number of sessions that succeeded.
    
    Failure – The number of sessions that failed.
    
    Dropped – The number of sessions that the user dropped.
    
    Duration – The duration of sessions.
    
    TurnsPerSession – The number of turns in the sessions.
    
    Concurrency – The number of sessions occurring in the same period of time.
    See Also:
    
    AnalyticsSessionMetricName
  - withName
```
public AnalyticsSessionMetric withName(String name)
```
    The metric for which you want to get session summary statistics.
    - Count – The number of sessions.
    - Success – The number of sessions that succeeded.
    - Failure – The number of sessions that failed.
    - Dropped – The number of sessions that the user dropped.
    - Duration – The duration of sessions.
    - TurnsPerSession – The number of turns in the sessions.
    - Concurrency – The number of sessions occurring in the same period of time.
    Parameters:
    name - The metric for which you want to get session summary statistics.
    
    Count – The number of sessions.
    
    Success – The number of sessions that succeeded.
    
    Failure – The number of sessions that failed.
    
    Dropped – The number of sessions that the user dropped.
    
    Duration – The duration of sessions.
    
    TurnsPerSession – The number of turns in the sessions.
    
    Concurrency – The number of sessions occurring in the same period of time.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsSessionMetricName
  - withName
```
public AnalyticsSessionMetric withName(AnalyticsSessionMetricName name)
```
    The metric for which you want to get session summary statistics.
    - Count – The number of sessions.
    - Success – The number of sessions that succeeded.
    - Failure – The number of sessions that failed.
    - Dropped – The number of sessions that the user dropped.
    - Duration – The duration of sessions.
    - TurnsPerSession – The number of turns in the sessions.
    - Concurrency – The number of sessions occurring in the same period of time.
    Parameters:
    name - The metric for which you want to get session summary statistics.
    
    Count – The number of sessions.
    
    Success – The number of sessions that succeeded.
    
    Failure – The number of sessions that failed.
    
    Dropped – The number of sessions that the user dropped.
    
    Duration – The duration of sessions.
    
    TurnsPerSession – The number of turns in the sessions.
    
    Concurrency – The number of sessions occurring in the same period of time.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsSessionMetricName
  - 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 sessions 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 sessions 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 sessions 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 sessions in the category you provide in name.
    
    Max – The highest count in the category you provide in name.
    See Also:
    
    AnalyticsMetricStatistic
  - withStatistic
```
public AnalyticsSessionMetric 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 sessions 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 sessions 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 AnalyticsSessionMetric 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 sessions 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 sessions 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 AnalyticsSessionMetric 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 AnalyticsSessionMetric 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 AnalyticsSessionMetric 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.793

Class AnalyticsSessionMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyticsSessionMetric

Method Detail

setName

getName

withName

withName

setStatistic

getStatistic

withStatistic

withStatistic

setOrder

getOrder

withOrder

withOrder

toString

equals

hashCode

clone

marshall