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

Interface PredictorMonitorEvaluation.Builder

    • Method Detail

      • resourceArn

        PredictorMonitorEvaluation.Builder resourceArn​(String 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

        PredictorMonitorEvaluation.Builder monitorArn​(String 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

        PredictorMonitorEvaluation.Builder evaluationTime​(Instant 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

        PredictorMonitorEvaluation.Builder evaluationState​(String evaluationState)

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

        Parameters:
        evaluationState - The status of the monitor evaluation. The state can be SUCCESS or FAILURE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • windowStartDatetime

        PredictorMonitorEvaluation.Builder windowStartDatetime​(Instant 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

        PredictorMonitorEvaluation.Builder windowEndDatetime​(Instant 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

        PredictorMonitorEvaluation.Builder predictorEvent​(PredictorEvent 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.

      • monitorDataSource

        PredictorMonitorEvaluation.Builder monitorDataSource​(MonitorDataSource 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.

      • metricResults

        PredictorMonitorEvaluation.Builder metricResults​(Collection<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.

        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

        PredictorMonitorEvaluation.Builder metricResults​(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.

        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

        PredictorMonitorEvaluation.Builder metricResults​(Consumer<MetricResult.Builder>... 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 the MetricResult.Builder avoiding the need to create one manually via MetricResult.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #metricResults(List).

        Parameters:
        metricResults - a consumer that will call methods on MetricResult.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #metricResults(java.util.Collection)

      • numItemsEvaluated

        PredictorMonitorEvaluation.Builder numItemsEvaluated​(Long 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

        PredictorMonitorEvaluation.Builder message​(String 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.