java.lang.Object
- software.amazon.awssdk.services.forecast.model.Metrics

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Metrics.Builder,Metrics>
```
@Generated("software.amazon.awssdk:codegen")
public final class Metrics
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Metrics.Builder,Metrics>
```
Provides metrics that are used to evaluate the performance of a predictor. This object is part of the WindowSummary object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Metrics.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Double`	`averageWeightedQuantileLoss()`	The average value of all weighted quantile losses.
`static Metrics.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ErrorMetric>`	`errorMetrics()`	Provides detailed error metrics for each forecast type.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasErrorMetrics()`	For responses, this returns true if the service returned a value for the ErrorMetrics property.
`int`	`hashCode()`
`boolean`	`hasWeightedQuantileLosses()`	For responses, this returns true if the service returned a value for the WeightedQuantileLosses property.
`Double`	`rmse()`	Deprecated. This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Metrics.Builder>`	`serializableBuilderClass()`
`Metrics.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<WeightedQuantileLoss>`	`weightedQuantileLosses()`	An array of weighted quantile losses.

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
  - rmse
```
@Deprecated
public final Double rmse()
```
    Deprecated.
    This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
    
    The root-mean-square error (RMSE).
    
    Returns:
    
    The root-mean-square error (RMSE).
  - hasWeightedQuantileLosses
```
public final boolean hasWeightedQuantileLosses()
```
    For responses, this returns true if the service returned a value for the WeightedQuantileLosses 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.
  - weightedQuantileLosses
```
public final List<WeightedQuantileLoss> weightedQuantileLosses()
```
    An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.
    
    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 hasWeightedQuantileLosses() method.
    
    Returns:
    
    An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.
  - hasErrorMetrics
```
public final boolean hasErrorMetrics()
```
    For responses, this returns true if the service returned a value for the ErrorMetrics 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.
  - errorMetrics
```
public final List<ErrorMetric> errorMetrics()
```
    Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).
    
    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 hasErrorMetrics() method.
    
    Returns:
    
    Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).
  - averageWeightedQuantileLoss
```
public final Double averageWeightedQuantileLoss()
```
    The average value of all weighted quantile losses.
    
    Returns:
    
    The average value of all weighted quantile losses.
  - toBuilder
```
public Metrics.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Metrics.Builder,Metrics>
  - builder
```
public static Metrics.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Metrics.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

Class Metrics

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

rmse

hasWeightedQuantileLosses

weightedQuantileLosses

hasErrorMetrics

errorMetrics

averageWeightedQuantileLoss

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields