software.amazon.awssdk.services.forecast.model

Class PredictorMonitorEvaluation

java.lang.Object

software.amazon.awssdk.services.forecast.model.PredictorMonitorEvaluation

All Implemented Interfaces:

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

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

Describes the results of a monitor evaluation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredictorMonitorEvaluation.Builder

Method Summary

Modifier and Type	Method and Description
static PredictorMonitorEvaluation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	evaluationState() The status of the monitor evaluation.
Instant	evaluationTime() The timestamp that indicates when the monitor evaluation was started.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricResults() For responses, this returns true if the service returned a value for the MetricResults property.
String	message() Information about any errors that may have occurred during the monitor evaluation.
List<MetricResult>	metricResults() A list of metrics Forecast calculated when monitoring a predictor.
String	monitorArn() The Amazon Resource Name (ARN) of the monitor resource.
MonitorDataSource	monitorDataSource() The source of the data the monitor resource used during the evaluation.
Long	numItemsEvaluated() The number of items considered during the evaluation.
PredictorEvent	predictorEvent() Provides details about a predictor event, such as a retraining.
String	resourceArn() The Amazon Resource Name (ARN) of the resource to monitor.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictorMonitorEvaluation.Builder>	serializableBuilderClass()
PredictorMonitorEvaluation.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	windowEndDatetime() The timestamp that indicates the end of the window that is used for monitor evaluation.
Instant	windowStartDatetime() The timestamp that indicates the start of the window that is used for monitor evaluation.

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

resourceArn

public final String resourceArn()

The Amazon Resource Name (ARN) of the resource to monitor.

Returns:

The Amazon Resource Name (ARN) of the resource to monitor.

monitorArn

public final String monitorArn()

The Amazon Resource Name (ARN) of the monitor resource.

Returns:

The Amazon Resource Name (ARN) of the monitor resource.

evaluationTime

public final Instant evaluationTime()

The timestamp that indicates when the monitor evaluation was started.

Returns:

The timestamp that indicates when the monitor evaluation was started.

evaluationState

public final String evaluationState()

The status of the monitor evaluation. The state can be SUCCESS or FAILURE.

Returns:

The status of the monitor evaluation. The state can be SUCCESS or FAILURE.

windowStartDatetime

public final Instant windowStartDatetime()

The timestamp that indicates the start of the window that is used for monitor evaluation.

Returns:

The timestamp that indicates the start of the window that is used for monitor evaluation.

windowEndDatetime

public final Instant windowEndDatetime()

The timestamp that indicates the end of the window that is used for monitor evaluation.

Returns:

The timestamp that indicates the end of the window that is used for monitor evaluation.

predictorEvent

public final PredictorEvent predictorEvent()

Provides details about a predictor event, such as a retraining.

Returns:

Provides details about a predictor event, such as a retraining.

monitorDataSource

public final MonitorDataSource monitorDataSource()

The source of the data the monitor resource used during the evaluation.

Returns:

The source of the data the monitor resource used during the evaluation.

hasMetricResults

public final boolean hasMetricResults()

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

metricResults

public final List<MetricResult> metricResults()

A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.

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

Returns:

A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.

numItemsEvaluated

public final Long numItemsEvaluated()

The number of items considered during the evaluation.

Returns:

The number of items considered during the evaluation.

message

public final String message()

Information about any errors that may have occurred during the monitor evaluation.

Returns:

Information about any errors that may have occurred during the monitor evaluation.

toBuilder

public PredictorMonitorEvaluation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictorMonitorEvaluation.Builder,PredictorMonitorEvaluation>

builder

public static PredictorMonitorEvaluation.Builder builder()

serializableBuilderClass

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