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

Class EvaluationResult

java.lang.Object

software.amazon.awssdk.services.forecast.model.EvaluationResult

All Implemented Interfaces:

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

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

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EvaluationResult.Builder

Method Summary

Modifier and Type	Method	Description
String	algorithmArn()	The Amazon Resource Name (ARN) of the algorithm that was evaluated.
static EvaluationResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTestWindows()	For responses, this returns true if the service returned a value for the TestWindows property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EvaluationResult.Builder>	serializableBuilderClass()
List<WindowSummary>	testWindows()	The array of test windows used for evaluating the algorithm.
EvaluationResult.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

algorithmArn

public final String algorithmArn()

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

Returns:

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

hasTestWindows

public final boolean hasTestWindows()

For responses, this returns true if the service returned a value for the TestWindows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

testWindows

public final List<WindowSummary> testWindows()

The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in the array.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTestWindows() method.

Returns:

The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in the array.

toBuilder

public EvaluationResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EvaluationResult.Builder,EvaluationResult>

builder

public static EvaluationResult.Builder builder()

serializableBuilderClass

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