Class AnalyticsSessionMetric

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsSessionMetric
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnalyticsSessionMetric.Builder,AnalyticsSessionMetric>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public AnalyticsSessionMetric.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AnalyticsSessionMetric.Builder,AnalyticsSessionMetric>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.