Package software.amazon.awssdk.services.lexmodelsv2.model

Class AnalyticsSessionMetricResult

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsSessionMetricResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalyticsSessionMetricResult.Builder,AnalyticsSessionMetricResult>

@Generated("software.amazon.awssdk:codegen")
public final class AnalyticsSessionMetricResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsSessionMetricResult.Builder,AnalyticsSessionMetricResult>

An object containing the results for a session metric you requested.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalyticsSessionMetricResult.Builder

Method Summary

Modifier and Type	Method	Description
static AnalyticsSessionMetricResult.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 that you requested.
String	nameAsString()	The metric that you requested.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsSessionMetricResult.Builder>	serializableBuilderClass()
AnalyticsMetricStatistic	statistic()	The summary statistic that you requested to calculate.
String	statisticAsString()	The summary statistic that you requested to calculate.
AnalyticsSessionMetricResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Double	value()	The value of the summary statistic for the metric that you requested.

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 that you requested.

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

• TurnPersession – 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 that you requested.

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

• TurnPersession – 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 that you requested.

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

• TurnPersession – 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 that you requested.

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

• TurnPersession – 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 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 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 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 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 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 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 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 sessions in the category you provide in name.

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

See Also:

AnalyticsMetricStatistic

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 AnalyticsSessionMetricResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsSessionMetricResult.Builder,AnalyticsSessionMetricResult>

builder

public static AnalyticsSessionMetricResult.Builder builder()

serializableBuilderClass

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