AnalyticsIntentStageMetric (AWS Java SDK :: Services

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

All Implemented Interfaces:

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

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AnalyticsIntentStageMetric.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AnalyticsIntentStageMetric.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`AnalyticsIntentStageMetricName`	`name()` The metric for which you want to get intent stage summary statistics.
`String`	`nameAsString()` The metric for which you want to get intent stage summary statistics.
`AnalyticsSortOrder`	`order()` Specifies whether to sort the results in ascending or descending order of the summary statistic ( `value` in the response).
`String`	`orderAsString()` Specifies whether to sort the results in ascending or descending order of the summary statistic ( `value` in the response).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnalyticsIntentStageMetric.Builder>`	`serializableBuilderClass()`
`AnalyticsMetricStatistic`	`statistic()` The summary statistic to calculate.
`String`	`statisticAsString()` The summary statistic to calculate.
`AnalyticsIntentStageMetric.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 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.
    If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsIntentStageMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().
    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
  - nameAsString
```
public final String nameAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsIntentStageMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().
    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
  - 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 intent stages 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 intent stages 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 intent stages 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 intent stages 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 of the summary statistic ( value in the response).
    
    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 of the summary statistic ( value in the response).
    
    See Also:
    
    AnalyticsSortOrder
  - orderAsString
```
public final String orderAsString()
```
    Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
    
    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 of the summary statistic ( value in the response).
    
    See Also:
    
    AnalyticsSortOrder
  - toBuilder
```
public AnalyticsIntentStageMetric.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalyticsIntentStageMetric.Builder,AnalyticsIntentStageMetric>
  - builder
```
public static AnalyticsIntentStageMetric.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalyticsIntentStageMetric.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 AnalyticsIntentStageMetric

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