Class WindowSummary

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

The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.

The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of the EvaluationParameters object.

See Also:

  • Method Details

    • testWindowStart

      public final Instant testWindowStart()

      The timestamp that defines the start of the window.

      Returns:
      The timestamp that defines the start of the window.

    • testWindowEnd

      public final Instant testWindowEnd()

      The timestamp that defines the end of the window.

      Returns:
      The timestamp that defines the end of the window.

    • itemCount

      public final Integer itemCount()

      The number of data points within the window.

      Returns:
      The number of data points within the window.

    • evaluationType

      public final EvaluationType evaluationType()

      The type of evaluation.

      • SUMMARY - The average metrics across all windows.

      • COMPUTED - The metrics for the specified window.

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

      Returns:
      The type of evaluation.

      • SUMMARY - The average metrics across all windows.

      • COMPUTED - The metrics for the specified window.

      See Also:

    • evaluationTypeAsString

      public final String evaluationTypeAsString()

      The type of evaluation.

      • SUMMARY - The average metrics across all windows.

      • COMPUTED - The metrics for the specified window.

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

      Returns:
      The type of evaluation.

      • SUMMARY - The average metrics across all windows.

      • COMPUTED - The metrics for the specified window.

      See Also:

    • metrics

      public final Metrics metrics()

      Provides metrics used to evaluate the performance of a predictor.

      Returns:
      Provides metrics used to evaluate the performance of a predictor.

    • toBuilder

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

    • builder

      public static WindowSummary.Builder builder()

    • serializableBuilderClass

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