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:

  • Method Details

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

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

    • 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()
      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<RelativeAggregationDuration.Builder,RelativeAggregationDuration>
      Returns:
      a builder for type T

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