Class AnalyticsIntentMetricResult

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsIntentMetricResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnalyticsIntentMetricResult.Builder,AnalyticsIntentMetricResult>
@Generated("software.amazon.awssdk:codegen") public final class AnalyticsIntentMetricResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsIntentMetricResult.Builder,AnalyticsIntentMetricResult>

An object containing the results for the intent metric you requested.

See Also:

  • Method Details

    • name

      public final AnalyticsIntentMetricName name()

      The metric that you requested. See Key definitions for more details about these metrics.

      • Count – The number of times the intent was invoked.

      • Success – The number of times the intent succeeded.

      • Failure – The number of times the intent failed.

      • Switched – The number of times there was a switch to a different intent.

      • Dropped – The number of times the user dropped the intent.

      If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsIntentMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The metric that you requested. See Key definitions for more details about these metrics.

      • Count – The number of times the intent was invoked.

      • Success – The number of times the intent succeeded.

      • Failure – The number of times the intent failed.

      • Switched – The number of times there was a switch to a different intent.

      • Dropped – The number of times the user dropped the intent.

      See Also:

    • nameAsString

      public final String nameAsString()

      The metric that you requested. See Key definitions for more details about these metrics.

      • Count – The number of times the intent was invoked.

      • Success – The number of times the intent succeeded.

      • Failure – The number of times the intent failed.

      • Switched – The number of times there was a switch to a different intent.

      • Dropped – The number of times the user dropped the intent.

      If the service returns an enum value that is not available in the current SDK version, name will return AnalyticsIntentMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

      Returns:
      The metric that you requested. See Key definitions for more details about these metrics.

      • Count – The number of times the intent was invoked.

      • Success – The number of times the intent succeeded.

      • Failure – The number of times the intent failed.

      • Switched – The number of times there was a switch to a different intent.

      • Dropped – The number of times the user dropped the intent.

      See Also:

    • statistic

      public final AnalyticsMetricStatistic statistic()

      The statistic that you requested to calculate.

      • Sum – The total count for the category you provide in name.

      • Average – The total count divided by the number of intents 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 statistic that you requested to calculate.

      • Sum – The total count for the category you provide in name.

      • Average – The total count divided by the number of intents 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 statistic that you requested to calculate.

      • Sum – The total count for the category you provide in name.

      • Average – The total count divided by the number of intents 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 statistic that you requested to calculate.

      • Sum – The total count for the category you provide in name.

      • Average – The total count divided by the number of intents in the category you provide in name.

      • Max – The highest count in the category you provide in name.

      See Also:

    • value

      public final Double value()

      The value of the summary statistic for the metric that you requested.

      Returns:
      The value of the summary statistic for the metric that you requested.

    • toBuilder

      public AnalyticsIntentMetricResult.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<AnalyticsIntentMetricResult.Builder,AnalyticsIntentMetricResult>
      Returns:
      a builder for type T

    • builder

      public static AnalyticsIntentMetricResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AnalyticsIntentMetricResult.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.