AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::ForecastService::Model::WindowSummary Class Reference

#include <WindowSummary.h>

Public Member Functions

 WindowSummary ()
 
 WindowSummary (Aws::Utils::Json::JsonView jsonValue)
 
WindowSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Utils::DateTimeGetTestWindowStart () const
 
bool TestWindowStartHasBeenSet () const
 
void SetTestWindowStart (const Aws::Utils::DateTime &value)
 
void SetTestWindowStart (Aws::Utils::DateTime &&value)
 
WindowSummaryWithTestWindowStart (const Aws::Utils::DateTime &value)
 
WindowSummaryWithTestWindowStart (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTestWindowEnd () const
 
bool TestWindowEndHasBeenSet () const
 
void SetTestWindowEnd (const Aws::Utils::DateTime &value)
 
void SetTestWindowEnd (Aws::Utils::DateTime &&value)
 
WindowSummaryWithTestWindowEnd (const Aws::Utils::DateTime &value)
 
WindowSummaryWithTestWindowEnd (Aws::Utils::DateTime &&value)
 
int GetItemCount () const
 
bool ItemCountHasBeenSet () const
 
void SetItemCount (int value)
 
WindowSummaryWithItemCount (int value)
 
const EvaluationTypeGetEvaluationType () const
 
bool EvaluationTypeHasBeenSet () const
 
void SetEvaluationType (const EvaluationType &value)
 
void SetEvaluationType (EvaluationType &&value)
 
WindowSummaryWithEvaluationType (const EvaluationType &value)
 
WindowSummaryWithEvaluationType (EvaluationType &&value)
 
const MetricsGetMetrics () const
 
bool MetricsHasBeenSet () const
 
void SetMetrics (const Metrics &value)
 
void SetMetrics (Metrics &&value)
 
WindowSummaryWithMetrics (const Metrics &value)
 
WindowSummaryWithMetrics (Metrics &&value)
 

Detailed Description

The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.

The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of the EvaluationParameters object.

See Also:

AWS API Reference

Definition at line 37 of file WindowSummary.h.

Constructor & Destructor Documentation

◆ WindowSummary() [1/2]

Aws::ForecastService::Model::WindowSummary::WindowSummary ( )

◆ WindowSummary() [2/2]

Aws::ForecastService::Model::WindowSummary::WindowSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EvaluationTypeHasBeenSet()

bool Aws::ForecastService::Model::WindowSummary::EvaluationTypeHasBeenSet ( ) const
inline

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

Definition at line 141 of file WindowSummary.h.

◆ GetEvaluationType()

const EvaluationType& Aws::ForecastService::Model::WindowSummary::GetEvaluationType ( ) const
inline

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

Definition at line 134 of file WindowSummary.h.

◆ GetItemCount()

int Aws::ForecastService::Model::WindowSummary::GetItemCount ( ) const
inline

The number of data points within the window.

Definition at line 111 of file WindowSummary.h.

◆ GetMetrics()

const Metrics& Aws::ForecastService::Model::WindowSummary::GetMetrics ( ) const
inline

Provides metrics used to evaluate the performance of a predictor.

Definition at line 175 of file WindowSummary.h.

◆ GetTestWindowEnd()

const Aws::Utils::DateTime& Aws::ForecastService::Model::WindowSummary::GetTestWindowEnd ( ) const
inline

The timestamp that defines the end of the window.

Definition at line 80 of file WindowSummary.h.

◆ GetTestWindowStart()

const Aws::Utils::DateTime& Aws::ForecastService::Model::WindowSummary::GetTestWindowStart ( ) const
inline

The timestamp that defines the start of the window.

Definition at line 49 of file WindowSummary.h.

◆ ItemCountHasBeenSet()

bool Aws::ForecastService::Model::WindowSummary::ItemCountHasBeenSet ( ) const
inline

The number of data points within the window.

Definition at line 116 of file WindowSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ForecastService::Model::WindowSummary::Jsonize ( ) const

◆ MetricsHasBeenSet()

bool Aws::ForecastService::Model::WindowSummary::MetricsHasBeenSet ( ) const
inline

Provides metrics used to evaluate the performance of a predictor.

Definition at line 180 of file WindowSummary.h.

◆ operator=()

WindowSummary& Aws::ForecastService::Model::WindowSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetEvaluationType() [1/2]

void Aws::ForecastService::Model::WindowSummary::SetEvaluationType ( const EvaluationType value)
inline

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

Definition at line 148 of file WindowSummary.h.

◆ SetEvaluationType() [2/2]

void Aws::ForecastService::Model::WindowSummary::SetEvaluationType ( EvaluationType &&  value)
inline

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

Definition at line 155 of file WindowSummary.h.

◆ SetItemCount()

void Aws::ForecastService::Model::WindowSummary::SetItemCount ( int  value)
inline

The number of data points within the window.

Definition at line 121 of file WindowSummary.h.

◆ SetMetrics() [1/2]

void Aws::ForecastService::Model::WindowSummary::SetMetrics ( const Metrics value)
inline

Provides metrics used to evaluate the performance of a predictor.

Definition at line 185 of file WindowSummary.h.

◆ SetMetrics() [2/2]

void Aws::ForecastService::Model::WindowSummary::SetMetrics ( Metrics &&  value)
inline

Provides metrics used to evaluate the performance of a predictor.

Definition at line 190 of file WindowSummary.h.

◆ SetTestWindowEnd() [1/2]

void Aws::ForecastService::Model::WindowSummary::SetTestWindowEnd ( Aws::Utils::DateTime &&  value)
inline

The timestamp that defines the end of the window.

Definition at line 95 of file WindowSummary.h.

◆ SetTestWindowEnd() [2/2]

void Aws::ForecastService::Model::WindowSummary::SetTestWindowEnd ( const Aws::Utils::DateTime value)
inline

The timestamp that defines the end of the window.

Definition at line 90 of file WindowSummary.h.

◆ SetTestWindowStart() [1/2]

void Aws::ForecastService::Model::WindowSummary::SetTestWindowStart ( Aws::Utils::DateTime &&  value)
inline

The timestamp that defines the start of the window.

Definition at line 64 of file WindowSummary.h.

◆ SetTestWindowStart() [2/2]

void Aws::ForecastService::Model::WindowSummary::SetTestWindowStart ( const Aws::Utils::DateTime value)
inline

The timestamp that defines the start of the window.

Definition at line 59 of file WindowSummary.h.

◆ TestWindowEndHasBeenSet()

bool Aws::ForecastService::Model::WindowSummary::TestWindowEndHasBeenSet ( ) const
inline

The timestamp that defines the end of the window.

Definition at line 85 of file WindowSummary.h.

◆ TestWindowStartHasBeenSet()

bool Aws::ForecastService::Model::WindowSummary::TestWindowStartHasBeenSet ( ) const
inline

The timestamp that defines the start of the window.

Definition at line 54 of file WindowSummary.h.

◆ WithEvaluationType() [1/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithEvaluationType ( const EvaluationType value)
inline

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

Definition at line 162 of file WindowSummary.h.

◆ WithEvaluationType() [2/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithEvaluationType ( EvaluationType &&  value)
inline

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

Definition at line 169 of file WindowSummary.h.

◆ WithItemCount()

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithItemCount ( int  value)
inline

The number of data points within the window.

Definition at line 126 of file WindowSummary.h.

◆ WithMetrics() [1/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithMetrics ( const Metrics value)
inline

Provides metrics used to evaluate the performance of a predictor.

Definition at line 195 of file WindowSummary.h.

◆ WithMetrics() [2/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithMetrics ( Metrics &&  value)
inline

Provides metrics used to evaluate the performance of a predictor.

Definition at line 200 of file WindowSummary.h.

◆ WithTestWindowEnd() [1/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithTestWindowEnd ( Aws::Utils::DateTime &&  value)
inline

The timestamp that defines the end of the window.

Definition at line 105 of file WindowSummary.h.

◆ WithTestWindowEnd() [2/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithTestWindowEnd ( const Aws::Utils::DateTime value)
inline

The timestamp that defines the end of the window.

Definition at line 100 of file WindowSummary.h.

◆ WithTestWindowStart() [1/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithTestWindowStart ( Aws::Utils::DateTime &&  value)
inline

The timestamp that defines the start of the window.

Definition at line 74 of file WindowSummary.h.

◆ WithTestWindowStart() [2/2]

WindowSummary& Aws::ForecastService::Model::WindowSummary::WithTestWindowStart ( const Aws::Utils::DateTime value)
inline

The timestamp that defines the start of the window.

Definition at line 69 of file WindowSummary.h.


The documentation for this class was generated from the following file: