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

#include <PredictorSummary.h>

Public Member Functions

 PredictorSummary ()
 
 PredictorSummary (Aws::Utils::Json::JsonView jsonValue)
 
PredictorSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetPredictorArn () const
 
bool PredictorArnHasBeenSet () const
 
void SetPredictorArn (const Aws::String &value)
 
void SetPredictorArn (Aws::String &&value)
 
void SetPredictorArn (const char *value)
 
PredictorSummaryWithPredictorArn (const Aws::String &value)
 
PredictorSummaryWithPredictorArn (Aws::String &&value)
 
PredictorSummaryWithPredictorArn (const char *value)
 
const Aws::StringGetPredictorName () const
 
bool PredictorNameHasBeenSet () const
 
void SetPredictorName (const Aws::String &value)
 
void SetPredictorName (Aws::String &&value)
 
void SetPredictorName (const char *value)
 
PredictorSummaryWithPredictorName (const Aws::String &value)
 
PredictorSummaryWithPredictorName (Aws::String &&value)
 
PredictorSummaryWithPredictorName (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)
 
PredictorSummaryWithDatasetGroupArn (const Aws::String &value)
 
PredictorSummaryWithDatasetGroupArn (Aws::String &&value)
 
PredictorSummaryWithDatasetGroupArn (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)
 
PredictorSummaryWithStatus (const Aws::String &value)
 
PredictorSummaryWithStatus (Aws::String &&value)
 
PredictorSummaryWithStatus (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)
 
PredictorSummaryWithMessage (const Aws::String &value)
 
PredictorSummaryWithMessage (Aws::String &&value)
 
PredictorSummaryWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
PredictorSummaryWithCreationTime (const Aws::Utils::DateTime &value)
 
PredictorSummaryWithCreationTime (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)
 
PredictorSummaryWithLastModificationTime (const Aws::Utils::DateTime &value)
 
PredictorSummaryWithLastModificationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

See Also:

AWS API Reference

Definition at line 35 of file PredictorSummary.h.

Constructor & Destructor Documentation

◆ PredictorSummary() [1/2]

Aws::ForecastService::Model::PredictorSummary::PredictorSummary ( )

◆ PredictorSummary() [2/2]

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

Member Function Documentation

◆ CreationTimeHasBeenSet()

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

When the model training task was created.

Definition at line 321 of file PredictorSummary.h.

◆ DatasetGroupArnHasBeenSet()

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

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

Definition at line 136 of file PredictorSummary.h.

◆ GetCreationTime()

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

When the model training task was created.

Definition at line 316 of file PredictorSummary.h.

◆ GetDatasetGroupArn()

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

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

Definition at line 130 of file PredictorSummary.h.

◆ GetLastModificationTime()

const Aws::Utils::DateTime& Aws::ForecastService::Model::PredictorSummary::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 353 of file PredictorSummary.h.

◆ GetMessage()

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

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

Definition at line 275 of file PredictorSummary.h.

◆ GetPredictorArn()

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

The ARN of the predictor.

Definition at line 47 of file PredictorSummary.h.

◆ GetPredictorName()

const Aws::String& Aws::ForecastService::Model::PredictorSummary::GetPredictorName ( ) const
inline

The name of the predictor.

Definition at line 88 of file PredictorSummary.h.

◆ GetStatus()

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 185 of file PredictorSummary.h.

◆ Jsonize()

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

◆ LastModificationTimeHasBeenSet()

bool Aws::ForecastService::Model::PredictorSummary::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 364 of file PredictorSummary.h.

◆ MessageHasBeenSet()

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

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

Definition at line 280 of file PredictorSummary.h.

◆ operator=()

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

◆ PredictorArnHasBeenSet()

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

The ARN of the predictor.

Definition at line 52 of file PredictorSummary.h.

◆ PredictorNameHasBeenSet()

bool Aws::ForecastService::Model::PredictorSummary::PredictorNameHasBeenSet ( ) const
inline

The name of the predictor.

Definition at line 93 of file PredictorSummary.h.

◆ SetCreationTime() [1/2]

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

When the model training task was created.

Definition at line 331 of file PredictorSummary.h.

◆ SetCreationTime() [2/2]

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

When the model training task was created.

Definition at line 326 of file PredictorSummary.h.

◆ SetDatasetGroupArn() [1/3]

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

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

Definition at line 148 of file PredictorSummary.h.

◆ SetDatasetGroupArn() [2/3]

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

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

Definition at line 142 of file PredictorSummary.h.

◆ SetDatasetGroupArn() [3/3]

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

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

Definition at line 154 of file PredictorSummary.h.

◆ SetLastModificationTime() [1/2]

void Aws::ForecastService::Model::PredictorSummary::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 386 of file PredictorSummary.h.

◆ SetLastModificationTime() [2/2]

void Aws::ForecastService::Model::PredictorSummary::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 375 of file PredictorSummary.h.

◆ SetMessage() [1/3]

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

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

Definition at line 290 of file PredictorSummary.h.

◆ SetMessage() [2/3]

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

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

Definition at line 285 of file PredictorSummary.h.

◆ SetMessage() [3/3]

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

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

Definition at line 295 of file PredictorSummary.h.

◆ SetPredictorArn() [1/3]

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

The ARN of the predictor.

Definition at line 62 of file PredictorSummary.h.

◆ SetPredictorArn() [2/3]

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

The ARN of the predictor.

Definition at line 57 of file PredictorSummary.h.

◆ SetPredictorArn() [3/3]

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

The ARN of the predictor.

Definition at line 67 of file PredictorSummary.h.

◆ SetPredictorName() [1/3]

void Aws::ForecastService::Model::PredictorSummary::SetPredictorName ( Aws::String &&  value)
inline

The name of the predictor.

Definition at line 103 of file PredictorSummary.h.

◆ SetPredictorName() [2/3]

void Aws::ForecastService::Model::PredictorSummary::SetPredictorName ( const Aws::String value)
inline

The name of the predictor.

Definition at line 98 of file PredictorSummary.h.

◆ SetPredictorName() [3/3]

void Aws::ForecastService::Model::PredictorSummary::SetPredictorName ( const char *  value)
inline

The name of the predictor.

Definition at line 108 of file PredictorSummary.h.

◆ SetStatus() [1/3]

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 221 of file PredictorSummary.h.

◆ SetStatus() [2/3]

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 209 of file PredictorSummary.h.

◆ SetStatus() [3/3]

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 233 of file PredictorSummary.h.

◆ StatusHasBeenSet()

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 197 of file PredictorSummary.h.

◆ WithCreationTime() [1/2]

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

When the model training task was created.

Definition at line 341 of file PredictorSummary.h.

◆ WithCreationTime() [2/2]

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

When the model training task was created.

Definition at line 336 of file PredictorSummary.h.

◆ WithDatasetGroupArn() [1/3]

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

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

Definition at line 166 of file PredictorSummary.h.

◆ WithDatasetGroupArn() [2/3]

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

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

Definition at line 160 of file PredictorSummary.h.

◆ WithDatasetGroupArn() [3/3]

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

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

Definition at line 172 of file PredictorSummary.h.

◆ WithLastModificationTime() [1/2]

PredictorSummary& Aws::ForecastService::Model::PredictorSummary::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 408 of file PredictorSummary.h.

◆ WithLastModificationTime() [2/2]

PredictorSummary& Aws::ForecastService::Model::PredictorSummary::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 397 of file PredictorSummary.h.

◆ WithMessage() [1/3]

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

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

Definition at line 305 of file PredictorSummary.h.

◆ WithMessage() [2/3]

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

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

Definition at line 300 of file PredictorSummary.h.

◆ WithMessage() [3/3]

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

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

Definition at line 310 of file PredictorSummary.h.

◆ WithPredictorArn() [1/3]

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

The ARN of the predictor.

Definition at line 77 of file PredictorSummary.h.

◆ WithPredictorArn() [2/3]

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

The ARN of the predictor.

Definition at line 72 of file PredictorSummary.h.

◆ WithPredictorArn() [3/3]

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

The ARN of the predictor.

Definition at line 82 of file PredictorSummary.h.

◆ WithPredictorName() [1/3]

PredictorSummary& Aws::ForecastService::Model::PredictorSummary::WithPredictorName ( Aws::String &&  value)
inline

The name of the predictor.

Definition at line 118 of file PredictorSummary.h.

◆ WithPredictorName() [2/3]

PredictorSummary& Aws::ForecastService::Model::PredictorSummary::WithPredictorName ( const Aws::String value)
inline

The name of the predictor.

Definition at line 113 of file PredictorSummary.h.

◆ WithPredictorName() [3/3]

PredictorSummary& Aws::ForecastService::Model::PredictorSummary::WithPredictorName ( const char *  value)
inline

The name of the predictor.

Definition at line 123 of file PredictorSummary.h.

◆ WithStatus() [1/3]

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 257 of file PredictorSummary.h.

◆ WithStatus() [2/3]

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 245 of file PredictorSummary.h.

◆ WithStatus() [3/3]

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

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Definition at line 269 of file PredictorSummary.h.


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