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

#include <ForecastExportJobSummary.h>

Public Member Functions

 ForecastExportJobSummary ()
 
 ForecastExportJobSummary (Aws::Utils::Json::JsonView jsonValue)
 
ForecastExportJobSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetForecastExportJobArn () const
 
bool ForecastExportJobArnHasBeenSet () const
 
void SetForecastExportJobArn (const Aws::String &value)
 
void SetForecastExportJobArn (Aws::String &&value)
 
void SetForecastExportJobArn (const char *value)
 
ForecastExportJobSummaryWithForecastExportJobArn (const Aws::String &value)
 
ForecastExportJobSummaryWithForecastExportJobArn (Aws::String &&value)
 
ForecastExportJobSummaryWithForecastExportJobArn (const char *value)
 
const Aws::StringGetForecastExportJobName () const
 
bool ForecastExportJobNameHasBeenSet () const
 
void SetForecastExportJobName (const Aws::String &value)
 
void SetForecastExportJobName (Aws::String &&value)
 
void SetForecastExportJobName (const char *value)
 
ForecastExportJobSummaryWithForecastExportJobName (const Aws::String &value)
 
ForecastExportJobSummaryWithForecastExportJobName (Aws::String &&value)
 
ForecastExportJobSummaryWithForecastExportJobName (const char *value)
 
const DataDestinationGetDestination () const
 
bool DestinationHasBeenSet () const
 
void SetDestination (const DataDestination &value)
 
void SetDestination (DataDestination &&value)
 
ForecastExportJobSummaryWithDestination (const DataDestination &value)
 
ForecastExportJobSummaryWithDestination (DataDestination &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ForecastExportJobSummaryWithStatus (const Aws::String &value)
 
ForecastExportJobSummaryWithStatus (Aws::String &&value)
 
ForecastExportJobSummaryWithStatus (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)
 
ForecastExportJobSummaryWithMessage (const Aws::String &value)
 
ForecastExportJobSummaryWithMessage (Aws::String &&value)
 
ForecastExportJobSummaryWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
ForecastExportJobSummaryWithCreationTime (const Aws::Utils::DateTime &value)
 
ForecastExportJobSummaryWithCreationTime (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)
 
ForecastExportJobSummaryWithLastModificationTime (const Aws::Utils::DateTime &value)
 
ForecastExportJobSummaryWithLastModificationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn.

See Also:

AWS API Reference

Definition at line 36 of file ForecastExportJobSummary.h.

Constructor & Destructor Documentation

◆ ForecastExportJobSummary() [1/2]

Aws::ForecastService::Model::ForecastExportJobSummary::ForecastExportJobSummary ( )

◆ ForecastExportJobSummary() [2/2]

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

Member Function Documentation

◆ CreationTimeHasBeenSet()

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

When the forecast export job was created.

Definition at line 310 of file ForecastExportJobSummary.h.

◆ DestinationHasBeenSet()

bool Aws::ForecastService::Model::ForecastExportJobSummary::DestinationHasBeenSet ( ) const
inline

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Definition at line 137 of file ForecastExportJobSummary.h.

◆ ForecastExportJobArnHasBeenSet()

bool Aws::ForecastService::Model::ForecastExportJobSummary::ForecastExportJobArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 53 of file ForecastExportJobSummary.h.

◆ ForecastExportJobNameHasBeenSet()

bool Aws::ForecastService::Model::ForecastExportJobSummary::ForecastExportJobNameHasBeenSet ( ) const
inline

The name of the forecast export job.

Definition at line 94 of file ForecastExportJobSummary.h.

◆ GetCreationTime()

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

When the forecast export job was created.

Definition at line 305 of file ForecastExportJobSummary.h.

◆ GetDestination()

const DataDestination& Aws::ForecastService::Model::ForecastExportJobSummary::GetDestination ( ) const
inline

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Definition at line 131 of file ForecastExportJobSummary.h.

◆ GetForecastExportJobArn()

const Aws::String& Aws::ForecastService::Model::ForecastExportJobSummary::GetForecastExportJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 48 of file ForecastExportJobSummary.h.

◆ GetForecastExportJobName()

const Aws::String& Aws::ForecastService::Model::ForecastExportJobSummary::GetForecastExportJobName ( ) const
inline

The name of the forecast export job.

Definition at line 89 of file ForecastExportJobSummary.h.

◆ GetLastModificationTime()

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

◆ GetMessage()

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

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

Definition at line 264 of file ForecastExportJobSummary.h.

◆ GetStatus()

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 174 of file ForecastExportJobSummary.h.

◆ Jsonize()

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

◆ LastModificationTimeHasBeenSet()

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

◆ MessageHasBeenSet()

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

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

Definition at line 269 of file ForecastExportJobSummary.h.

◆ operator=()

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

◆ SetCreationTime() [1/2]

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

When the forecast export job was created.

Definition at line 320 of file ForecastExportJobSummary.h.

◆ SetCreationTime() [2/2]

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

When the forecast export job was created.

Definition at line 315 of file ForecastExportJobSummary.h.

◆ SetDestination() [1/2]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetDestination ( const DataDestination value)
inline

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Definition at line 143 of file ForecastExportJobSummary.h.

◆ SetDestination() [2/2]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetDestination ( DataDestination &&  value)
inline

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Definition at line 149 of file ForecastExportJobSummary.h.

◆ SetForecastExportJobArn() [1/3]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetForecastExportJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 63 of file ForecastExportJobSummary.h.

◆ SetForecastExportJobArn() [2/3]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetForecastExportJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 58 of file ForecastExportJobSummary.h.

◆ SetForecastExportJobArn() [3/3]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetForecastExportJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 68 of file ForecastExportJobSummary.h.

◆ SetForecastExportJobName() [1/3]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetForecastExportJobName ( Aws::String &&  value)
inline

The name of the forecast export job.

Definition at line 104 of file ForecastExportJobSummary.h.

◆ SetForecastExportJobName() [2/3]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetForecastExportJobName ( const Aws::String value)
inline

The name of the forecast export job.

Definition at line 99 of file ForecastExportJobSummary.h.

◆ SetForecastExportJobName() [3/3]

void Aws::ForecastService::Model::ForecastExportJobSummary::SetForecastExportJobName ( const char *  value)
inline

The name of the forecast export job.

Definition at line 109 of file ForecastExportJobSummary.h.

◆ SetLastModificationTime() [1/2]

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

◆ SetLastModificationTime() [2/2]

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

◆ SetMessage() [1/3]

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

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

Definition at line 279 of file ForecastExportJobSummary.h.

◆ SetMessage() [2/3]

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

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

Definition at line 274 of file ForecastExportJobSummary.h.

◆ SetMessage() [3/3]

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

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

Definition at line 284 of file ForecastExportJobSummary.h.

◆ SetStatus() [1/3]

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 210 of file ForecastExportJobSummary.h.

◆ SetStatus() [2/3]

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 198 of file ForecastExportJobSummary.h.

◆ SetStatus() [3/3]

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 222 of file ForecastExportJobSummary.h.

◆ StatusHasBeenSet()

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 186 of file ForecastExportJobSummary.h.

◆ WithCreationTime() [1/2]

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

When the forecast export job was created.

Definition at line 330 of file ForecastExportJobSummary.h.

◆ WithCreationTime() [2/2]

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

When the forecast export job was created.

Definition at line 325 of file ForecastExportJobSummary.h.

◆ WithDestination() [1/2]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithDestination ( const DataDestination value)
inline

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Definition at line 155 of file ForecastExportJobSummary.h.

◆ WithDestination() [2/2]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithDestination ( DataDestination &&  value)
inline

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Definition at line 161 of file ForecastExportJobSummary.h.

◆ WithForecastExportJobArn() [1/3]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithForecastExportJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 78 of file ForecastExportJobSummary.h.

◆ WithForecastExportJobArn() [2/3]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithForecastExportJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 73 of file ForecastExportJobSummary.h.

◆ WithForecastExportJobArn() [3/3]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithForecastExportJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the forecast export job.

Definition at line 83 of file ForecastExportJobSummary.h.

◆ WithForecastExportJobName() [1/3]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithForecastExportJobName ( Aws::String &&  value)
inline

The name of the forecast export job.

Definition at line 119 of file ForecastExportJobSummary.h.

◆ WithForecastExportJobName() [2/3]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithForecastExportJobName ( const Aws::String value)
inline

The name of the forecast export job.

Definition at line 114 of file ForecastExportJobSummary.h.

◆ WithForecastExportJobName() [3/3]

ForecastExportJobSummary& Aws::ForecastService::Model::ForecastExportJobSummary::WithForecastExportJobName ( const char *  value)
inline

The name of the forecast export job.

Definition at line 124 of file ForecastExportJobSummary.h.

◆ WithLastModificationTime() [1/2]

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

◆ WithLastModificationTime() [2/2]

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

◆ WithMessage() [1/3]

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

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

Definition at line 294 of file ForecastExportJobSummary.h.

◆ WithMessage() [2/3]

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

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

Definition at line 289 of file ForecastExportJobSummary.h.

◆ WithMessage() [3/3]

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

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

Definition at line 299 of file ForecastExportJobSummary.h.

◆ WithStatus() [1/3]

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 246 of file ForecastExportJobSummary.h.

◆ WithStatus() [2/3]

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 234 of file ForecastExportJobSummary.h.

◆ WithStatus() [3/3]

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

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Definition at line 258 of file ForecastExportJobSummary.h.


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