AnalyticsSessionMetric (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsSessionMetric

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalyticsSessionMetric.Builder,AnalyticsSessionMetric>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AnalyticsSessionMetric
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsSessionMetric.Builder,AnalyticsSessionMetric>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AnalyticsSessionMetric.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AnalyticsSessionMetric.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AnalyticsSessionMetric.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`AnalyticsSessionMetricName`	`name()` The metric for which you want to get session summary statistics.
`String`	`nameAsString()` The metric for which you want to get session summary statistics.
`AnalyticsSortOrder`	`order()` Specifies whether to sort the results in ascending or descending order.
`String`	`orderAsString()` Specifies whether to sort the results in ascending or descending order.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnalyticsSessionMetric.Builder>`	`serializableBuilderClass()`
`AnalyticsMetricStatistic`	`statistic()` The summary statistic to calculate.
`String`	`statisticAsString()` The summary statistic to calculate.
`AnalyticsSessionMetric.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsSessionMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().
    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
  - nameAsString
```
public final String nameAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsSessionMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().
    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
  - statistic
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, statistic will return AnalyticsMetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().
    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
  - statisticAsString
```
public final String statisticAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, statistic will return AnalyticsMetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().
    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
  - order
```
public final AnalyticsSortOrder order()
```
    Specifies whether to sort the results in ascending or descending order.
    
    If the service returns an enum value that is not available in the current SDK version, order will return AnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().
    
    Returns:
    
    Specifies whether to sort the results in ascending or descending order.
    
    See Also:
    
    AnalyticsSortOrder
  - orderAsString
```
public final String orderAsString()
```
    Specifies whether to sort the results in ascending or descending order.
    
    If the service returns an enum value that is not available in the current SDK version, order will return AnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().
    
    Returns:
    
    Specifies whether to sort the results in ascending or descending order.
    
    See Also:
    
    AnalyticsSortOrder
  - toBuilder
```
public AnalyticsSessionMetric.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalyticsSessionMetric.Builder,AnalyticsSessionMetric>
  - builder
```
public static AnalyticsSessionMetric.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalyticsSessionMetric.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AnalyticsSessionMetric

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

nameAsString

statistic

statisticAsString

order

orderAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields