software.amazon.awssdk.services.forecast.model

Class PredictorBaseline

java.lang.Object

software.amazon.awssdk.services.forecast.model.PredictorBaseline

All Implemented Interfaces:

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

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

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredictorBaseline.Builder

Method Summary

Modifier and Type	Method and Description
List<BaselineMetric>	baselineMetrics() The initial accuracy metrics for the predictor.
static PredictorBaseline.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBaselineMetrics() For responses, this returns true if the service returned a value for the BaselineMetrics property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PredictorBaseline.Builder>	serializableBuilderClass()
PredictorBaseline.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

hasBaselineMetrics

public final boolean hasBaselineMetrics()

For responses, this returns true if the service returned a value for the BaselineMetrics 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.

baselineMetrics

public final List<BaselineMetric> baselineMetrics()

The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.

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 hasBaselineMetrics() method.

Returns:

The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.

toBuilder

public PredictorBaseline.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictorBaseline.Builder,PredictorBaseline>

builder

public static PredictorBaseline.Builder builder()

serializableBuilderClass

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