Package software.amazon.awssdk.services.forecast.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WindowSummary.Builder

Method Summary

Modifier and Type	Method	Description
static WindowSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EvaluationType	evaluationType()	The type of evaluation.
String	evaluationTypeAsString()	The type of evaluation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	itemCount()	The number of data points within the window.
Metrics	metrics()	Provides metrics used to evaluate the performance of a predictor.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WindowSummary.Builder>	serializableBuilderClass()
Instant	testWindowEnd()	The timestamp that defines the end of the window.
Instant	testWindowStart()	The timestamp that defines the start of the window.
WindowSummary.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

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:

EvaluationType

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:

EvaluationType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<WindowSummary.Builder,WindowSummary>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo