Interface PredictorMonitorEvaluation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PredictorMonitorEvaluation.Builder,
,PredictorMonitorEvaluation> SdkBuilder<PredictorMonitorEvaluation.Builder,
,PredictorMonitorEvaluation> SdkPojo
- Enclosing class:
PredictorMonitorEvaluation
-
Method Summary
Modifier and TypeMethodDescriptionevaluationState
(String evaluationState) The status of the monitor evaluation.evaluationTime
(Instant evaluationTime) The timestamp that indicates when the monitor evaluation was started.Information about any errors that may have occurred during the monitor evaluation.metricResults
(Collection<MetricResult> metricResults) A list of metrics Forecast calculated when monitoring a predictor.metricResults
(Consumer<MetricResult.Builder>... metricResults) A list of metrics Forecast calculated when monitoring a predictor.metricResults
(MetricResult... metricResults) A list of metrics Forecast calculated when monitoring a predictor.monitorArn
(String monitorArn) The Amazon Resource Name (ARN) of the monitor resource.monitorDataSource
(Consumer<MonitorDataSource.Builder> monitorDataSource) The source of the data the monitor resource used during the evaluation.monitorDataSource
(MonitorDataSource monitorDataSource) The source of the data the monitor resource used during the evaluation.numItemsEvaluated
(Long numItemsEvaluated) The number of items considered during the evaluation.predictorEvent
(Consumer<PredictorEvent.Builder> predictorEvent) Provides details about a predictor event, such as a retraining.predictorEvent
(PredictorEvent predictorEvent) Provides details about a predictor event, such as a retraining.resourceArn
(String resourceArn) The Amazon Resource Name (ARN) of the resource to monitor.windowEndDatetime
(Instant windowEndDatetime) The timestamp that indicates the end of the window that is used for monitor evaluation.windowStartDatetime
(Instant windowStartDatetime) The timestamp that indicates the start of the window that is used for monitor evaluation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
resourceArn
The Amazon Resource Name (ARN) of the resource to monitor.
- Parameters:
resourceArn
- The Amazon Resource Name (ARN) of the resource to monitor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
monitorArn
The Amazon Resource Name (ARN) of the monitor resource.
- Parameters:
monitorArn
- The Amazon Resource Name (ARN) of the monitor resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationTime
The timestamp that indicates when the monitor evaluation was started.
- Parameters:
evaluationTime
- The timestamp that indicates when the monitor evaluation was started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
evaluationState
The status of the monitor evaluation. The state can be
SUCCESS
orFAILURE
.- Parameters:
evaluationState
- The status of the monitor evaluation. The state can beSUCCESS
orFAILURE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
windowStartDatetime
The timestamp that indicates the start of the window that is used for monitor evaluation.
- Parameters:
windowStartDatetime
- The timestamp that indicates the start of the window that is used for monitor evaluation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
windowEndDatetime
The timestamp that indicates the end of the window that is used for monitor evaluation.
- Parameters:
windowEndDatetime
- The timestamp that indicates the end of the window that is used for monitor evaluation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predictorEvent
Provides details about a predictor event, such as a retraining.
- Parameters:
predictorEvent
- Provides details about a predictor event, such as a retraining.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predictorEvent
default PredictorMonitorEvaluation.Builder predictorEvent(Consumer<PredictorEvent.Builder> predictorEvent) Provides details about a predictor event, such as a retraining.
This is a convenience method that creates an instance of thePredictorEvent.Builder
avoiding the need to create one manually viaPredictorEvent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topredictorEvent(PredictorEvent)
.- Parameters:
predictorEvent
- a consumer that will call methods onPredictorEvent.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
monitorDataSource
The source of the data the monitor resource used during the evaluation.
- Parameters:
monitorDataSource
- The source of the data the monitor resource used during the evaluation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
monitorDataSource
default PredictorMonitorEvaluation.Builder monitorDataSource(Consumer<MonitorDataSource.Builder> monitorDataSource) The source of the data the monitor resource used during the evaluation.
This is a convenience method that creates an instance of theMonitorDataSource.Builder
avoiding the need to create one manually viaMonitorDataSource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomonitorDataSource(MonitorDataSource)
.- Parameters:
monitorDataSource
- a consumer that will call methods onMonitorDataSource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theMetricResult.Builder
avoiding the need to create one manually viaMetricResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometricResults(List<MetricResult>)
.- Parameters:
metricResults
- a consumer that will call methods onMetricResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
numItemsEvaluated
The number of items considered during the evaluation.
- Parameters:
numItemsEvaluated
- The number of items considered during the evaluation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
message
Information about any errors that may have occurred during the monitor evaluation.
- Parameters:
message
- Information about any errors that may have occurred during the monitor evaluation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-