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

Class RelativeAggregationDuration

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.RelativeAggregationDuration

All Implemented Interfaces:

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

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

Specifies the time window that utterance statistics are returned for. The time window is always relative to the last time that the that utterances were aggregated. For example, if the ListAggregatedUtterances operation is called at 1600, the time window is set to 1 hour, and the last refresh time was 1530, only utterances made between 1430 and 1530 are returned.

You can choose the time window that statistics should be returned for.

• Hours - You can request utterance statistics for 1, 3, 6, 12, or 24 hour time windows. Statistics are refreshed every half hour for 1 hour time windows, and hourly for the other time windows.

• Days - You can request utterance statistics for 3 days. Statistics are refreshed every 6 hours.

• Weeks - You can see statistics for one or two weeks. Statistics are refreshed every 12 hours for one week time windows, and once per day for two week time windows.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RelativeAggregationDuration.Builder

Method Summary

Modifier and Type	Method	Description
static RelativeAggregationDuration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RelativeAggregationDuration.Builder>	serializableBuilderClass()
TimeDimension	timeDimension()	The type of time period that the timeValue field represents.
String	timeDimensionAsString()	The type of time period that the timeValue field represents.
Integer	timeValue()	The period of the time window to gather statistics for.
RelativeAggregationDuration.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

timeDimension

public final TimeDimension timeDimension()

The type of time period that the timeValue field represents.

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

Returns:

The type of time period that the timeValue field represents.

See Also:

TimeDimension

timeDimensionAsString

public final String timeDimensionAsString()

The type of time period that the timeValue field represents.

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

Returns:

The type of time period that the timeValue field represents.

See Also:

TimeDimension

timeValue

public final Integer timeValue()

The period of the time window to gather statistics for. The valid value depends on the setting of the timeDimension field.

• Hours - 1/3/6/12/24

• Days - 3

• Weeks - 1/2

Returns:

The period of the time window to gather statistics for. The valid value depends on the setting of the timeDimension field.

• Hours - 1/3/6/12/24

• Days - 3

• Weeks - 1/2

toBuilder

public RelativeAggregationDuration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RelativeAggregationDuration.Builder,RelativeAggregationDuration>

builder

public static RelativeAggregationDuration.Builder builder()

serializableBuilderClass

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