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

#include <ForecastSummary.h>

Public Member Functions

 ForecastSummary ()
 
 ForecastSummary (Aws::Utils::Json::JsonView jsonValue)
 
ForecastSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetForecastArn () const
 
bool ForecastArnHasBeenSet () const
 
void SetForecastArn (const Aws::String &value)
 
void SetForecastArn (Aws::String &&value)
 
void SetForecastArn (const char *value)
 
ForecastSummaryWithForecastArn (const Aws::String &value)
 
ForecastSummaryWithForecastArn (Aws::String &&value)
 
ForecastSummaryWithForecastArn (const char *value)
 
const Aws::StringGetForecastName () const
 
bool ForecastNameHasBeenSet () const
 
void SetForecastName (const Aws::String &value)
 
void SetForecastName (Aws::String &&value)
 
void SetForecastName (const char *value)
 
ForecastSummaryWithForecastName (const Aws::String &value)
 
ForecastSummaryWithForecastName (Aws::String &&value)
 
ForecastSummaryWithForecastName (const char *value)
 
const Aws::StringGetPredictorArn () const
 
bool PredictorArnHasBeenSet () const
 
void SetPredictorArn (const Aws::String &value)
 
void SetPredictorArn (Aws::String &&value)
 
void SetPredictorArn (const char *value)
 
ForecastSummaryWithPredictorArn (const Aws::String &value)
 
ForecastSummaryWithPredictorArn (Aws::String &&value)
 
ForecastSummaryWithPredictorArn (const char *value)
 
const Aws::StringGetDatasetGroupArn () const
 
bool DatasetGroupArnHasBeenSet () const
 
void SetDatasetGroupArn (const Aws::String &value)
 
void SetDatasetGroupArn (Aws::String &&value)
 
void SetDatasetGroupArn (const char *value)
 
ForecastSummaryWithDatasetGroupArn (const Aws::String &value)
 
ForecastSummaryWithDatasetGroupArn (Aws::String &&value)
 
ForecastSummaryWithDatasetGroupArn (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ForecastSummaryWithStatus (const Aws::String &value)
 
ForecastSummaryWithStatus (Aws::String &&value)
 
ForecastSummaryWithStatus (const char *value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
ForecastSummaryWithMessage (const Aws::String &value)
 
ForecastSummaryWithMessage (Aws::String &&value)
 
ForecastSummaryWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
ForecastSummaryWithCreationTime (const Aws::Utils::DateTime &value)
 
ForecastSummaryWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModificationTime () const
 
bool LastModificationTimeHasBeenSet () const
 
void SetLastModificationTime (const Aws::Utils::DateTime &value)
 
void SetLastModificationTime (Aws::Utils::DateTime &&value)
 
ForecastSummaryWithLastModificationTime (const Aws::Utils::DateTime &value)
 
ForecastSummaryWithLastModificationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.

See Also:

AWS API Reference

Definition at line 35 of file ForecastSummary.h.

Constructor & Destructor Documentation

◆ ForecastSummary() [1/2]

Aws::ForecastService::Model::ForecastSummary::ForecastSummary ( )

◆ ForecastSummary() [2/2]

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

Member Function Documentation

◆ CreationTimeHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::CreationTimeHasBeenSet ( ) const
inline

When the forecast creation task was created.

Definition at line 362 of file ForecastSummary.h.

◆ DatasetGroupArnHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::DatasetGroupArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 177 of file ForecastSummary.h.

◆ ForecastArnHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::ForecastArnHasBeenSet ( ) const
inline

The ARN of the forecast.

Definition at line 52 of file ForecastSummary.h.

◆ ForecastNameHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::ForecastNameHasBeenSet ( ) const
inline

The name of the forecast.

Definition at line 93 of file ForecastSummary.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::ForecastService::Model::ForecastSummary::GetCreationTime ( ) const
inline

When the forecast creation task was created.

Definition at line 357 of file ForecastSummary.h.

◆ GetDatasetGroupArn()

const Aws::String& Aws::ForecastService::Model::ForecastSummary::GetDatasetGroupArn ( ) const
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 171 of file ForecastSummary.h.

◆ GetForecastArn()

const Aws::String& Aws::ForecastService::Model::ForecastSummary::GetForecastArn ( ) const
inline

The ARN of the forecast.

Definition at line 47 of file ForecastSummary.h.

◆ GetForecastName()

const Aws::String& Aws::ForecastService::Model::ForecastSummary::GetForecastName ( ) const
inline

The name of the forecast.

Definition at line 88 of file ForecastSummary.h.

◆ GetLastModificationTime()

const Aws::Utils::DateTime& Aws::ForecastService::Model::ForecastSummary::GetLastModificationTime ( ) const
inline

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Definition at line 394 of file ForecastSummary.h.

◆ GetMessage()

const Aws::String& Aws::ForecastService::Model::ForecastSummary::GetMessage ( ) const
inline

If an error occurred, an informational message about the error.

Definition at line 316 of file ForecastSummary.h.

◆ GetPredictorArn()

const Aws::String& Aws::ForecastService::Model::ForecastSummary::GetPredictorArn ( ) const
inline

The ARN of the predictor used to generate the forecast.

Definition at line 129 of file ForecastSummary.h.

◆ GetStatus()

const Aws::String& Aws::ForecastService::Model::ForecastSummary::GetStatus ( ) const
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 226 of file ForecastSummary.h.

◆ Jsonize()

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

◆ LastModificationTimeHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::LastModificationTimeHasBeenSet ( ) const
inline

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Definition at line 405 of file ForecastSummary.h.

◆ MessageHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::MessageHasBeenSet ( ) const
inline

If an error occurred, an informational message about the error.

Definition at line 321 of file ForecastSummary.h.

◆ operator=()

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

◆ PredictorArnHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::PredictorArnHasBeenSet ( ) const
inline

The ARN of the predictor used to generate the forecast.

Definition at line 134 of file ForecastSummary.h.

◆ SetCreationTime() [1/2]

void Aws::ForecastService::Model::ForecastSummary::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

When the forecast creation task was created.

Definition at line 372 of file ForecastSummary.h.

◆ SetCreationTime() [2/2]

void Aws::ForecastService::Model::ForecastSummary::SetCreationTime ( const Aws::Utils::DateTime value)
inline

When the forecast creation task was created.

Definition at line 367 of file ForecastSummary.h.

◆ SetDatasetGroupArn() [1/3]

void Aws::ForecastService::Model::ForecastSummary::SetDatasetGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 189 of file ForecastSummary.h.

◆ SetDatasetGroupArn() [2/3]

void Aws::ForecastService::Model::ForecastSummary::SetDatasetGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 183 of file ForecastSummary.h.

◆ SetDatasetGroupArn() [3/3]

void Aws::ForecastService::Model::ForecastSummary::SetDatasetGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 195 of file ForecastSummary.h.

◆ SetForecastArn() [1/3]

void Aws::ForecastService::Model::ForecastSummary::SetForecastArn ( Aws::String &&  value)
inline

The ARN of the forecast.

Definition at line 62 of file ForecastSummary.h.

◆ SetForecastArn() [2/3]

void Aws::ForecastService::Model::ForecastSummary::SetForecastArn ( const Aws::String value)
inline

The ARN of the forecast.

Definition at line 57 of file ForecastSummary.h.

◆ SetForecastArn() [3/3]

void Aws::ForecastService::Model::ForecastSummary::SetForecastArn ( const char *  value)
inline

The ARN of the forecast.

Definition at line 67 of file ForecastSummary.h.

◆ SetForecastName() [1/3]

void Aws::ForecastService::Model::ForecastSummary::SetForecastName ( Aws::String &&  value)
inline

The name of the forecast.

Definition at line 103 of file ForecastSummary.h.

◆ SetForecastName() [2/3]

void Aws::ForecastService::Model::ForecastSummary::SetForecastName ( const Aws::String value)
inline

The name of the forecast.

Definition at line 98 of file ForecastSummary.h.

◆ SetForecastName() [3/3]

void Aws::ForecastService::Model::ForecastSummary::SetForecastName ( const char *  value)
inline

The name of the forecast.

Definition at line 108 of file ForecastSummary.h.

◆ SetLastModificationTime() [1/2]

void Aws::ForecastService::Model::ForecastSummary::SetLastModificationTime ( Aws::Utils::DateTime &&  value)
inline

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Definition at line 427 of file ForecastSummary.h.

◆ SetLastModificationTime() [2/2]

void Aws::ForecastService::Model::ForecastSummary::SetLastModificationTime ( const Aws::Utils::DateTime value)
inline

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Definition at line 416 of file ForecastSummary.h.

◆ SetMessage() [1/3]

void Aws::ForecastService::Model::ForecastSummary::SetMessage ( Aws::String &&  value)
inline

If an error occurred, an informational message about the error.

Definition at line 331 of file ForecastSummary.h.

◆ SetMessage() [2/3]

void Aws::ForecastService::Model::ForecastSummary::SetMessage ( const Aws::String value)
inline

If an error occurred, an informational message about the error.

Definition at line 326 of file ForecastSummary.h.

◆ SetMessage() [3/3]

void Aws::ForecastService::Model::ForecastSummary::SetMessage ( const char *  value)
inline

If an error occurred, an informational message about the error.

Definition at line 336 of file ForecastSummary.h.

◆ SetPredictorArn() [1/3]

void Aws::ForecastService::Model::ForecastSummary::SetPredictorArn ( Aws::String &&  value)
inline

The ARN of the predictor used to generate the forecast.

Definition at line 144 of file ForecastSummary.h.

◆ SetPredictorArn() [2/3]

void Aws::ForecastService::Model::ForecastSummary::SetPredictorArn ( const Aws::String value)
inline

The ARN of the predictor used to generate the forecast.

Definition at line 139 of file ForecastSummary.h.

◆ SetPredictorArn() [3/3]

void Aws::ForecastService::Model::ForecastSummary::SetPredictorArn ( const char *  value)
inline

The ARN of the predictor used to generate the forecast.

Definition at line 149 of file ForecastSummary.h.

◆ SetStatus() [1/3]

void Aws::ForecastService::Model::ForecastSummary::SetStatus ( Aws::String &&  value)
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 262 of file ForecastSummary.h.

◆ SetStatus() [2/3]

void Aws::ForecastService::Model::ForecastSummary::SetStatus ( const Aws::String value)
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 250 of file ForecastSummary.h.

◆ SetStatus() [3/3]

void Aws::ForecastService::Model::ForecastSummary::SetStatus ( const char *  value)
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 274 of file ForecastSummary.h.

◆ StatusHasBeenSet()

bool Aws::ForecastService::Model::ForecastSummary::StatusHasBeenSet ( ) const
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 238 of file ForecastSummary.h.

◆ WithCreationTime() [1/2]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

When the forecast creation task was created.

Definition at line 382 of file ForecastSummary.h.

◆ WithCreationTime() [2/2]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithCreationTime ( const Aws::Utils::DateTime value)
inline

When the forecast creation task was created.

Definition at line 377 of file ForecastSummary.h.

◆ WithDatasetGroupArn() [1/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithDatasetGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 207 of file ForecastSummary.h.

◆ WithDatasetGroupArn() [2/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithDatasetGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 201 of file ForecastSummary.h.

◆ WithDatasetGroupArn() [3/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithDatasetGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Definition at line 213 of file ForecastSummary.h.

◆ WithForecastArn() [1/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithForecastArn ( Aws::String &&  value)
inline

The ARN of the forecast.

Definition at line 77 of file ForecastSummary.h.

◆ WithForecastArn() [2/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithForecastArn ( const Aws::String value)
inline

The ARN of the forecast.

Definition at line 72 of file ForecastSummary.h.

◆ WithForecastArn() [3/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithForecastArn ( const char *  value)
inline

The ARN of the forecast.

Definition at line 82 of file ForecastSummary.h.

◆ WithForecastName() [1/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithForecastName ( Aws::String &&  value)
inline

The name of the forecast.

Definition at line 118 of file ForecastSummary.h.

◆ WithForecastName() [2/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithForecastName ( const Aws::String value)
inline

The name of the forecast.

Definition at line 113 of file ForecastSummary.h.

◆ WithForecastName() [3/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithForecastName ( const char *  value)
inline

The name of the forecast.

Definition at line 123 of file ForecastSummary.h.

◆ WithLastModificationTime() [1/2]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithLastModificationTime ( Aws::Utils::DateTime &&  value)
inline

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Definition at line 449 of file ForecastSummary.h.

◆ WithLastModificationTime() [2/2]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithLastModificationTime ( const Aws::Utils::DateTime value)
inline

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Definition at line 438 of file ForecastSummary.h.

◆ WithMessage() [1/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithMessage ( Aws::String &&  value)
inline

If an error occurred, an informational message about the error.

Definition at line 346 of file ForecastSummary.h.

◆ WithMessage() [2/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithMessage ( const Aws::String value)
inline

If an error occurred, an informational message about the error.

Definition at line 341 of file ForecastSummary.h.

◆ WithMessage() [3/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithMessage ( const char *  value)
inline

If an error occurred, an informational message about the error.

Definition at line 351 of file ForecastSummary.h.

◆ WithPredictorArn() [1/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithPredictorArn ( Aws::String &&  value)
inline

The ARN of the predictor used to generate the forecast.

Definition at line 159 of file ForecastSummary.h.

◆ WithPredictorArn() [2/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithPredictorArn ( const Aws::String value)
inline

The ARN of the predictor used to generate the forecast.

Definition at line 154 of file ForecastSummary.h.

◆ WithPredictorArn() [3/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithPredictorArn ( const char *  value)
inline

The ARN of the predictor used to generate the forecast.

Definition at line 164 of file ForecastSummary.h.

◆ WithStatus() [1/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithStatus ( Aws::String &&  value)
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 298 of file ForecastSummary.h.

◆ WithStatus() [2/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithStatus ( const Aws::String value)
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 286 of file ForecastSummary.h.

◆ WithStatus() [3/3]

ForecastSummary& Aws::ForecastService::Model::ForecastSummary::WithStatus ( const char *  value)
inline

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Definition at line 310 of file ForecastSummary.h.


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