AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::Personalize::Model::CampaignSummary Class Reference

#include <CampaignSummary.h>

Public Member Functions

 CampaignSummary ()
 
 CampaignSummary (Aws::Utils::Json::JsonView jsonValue)
 
CampaignSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CampaignSummaryWithName (const Aws::String &value)
 
CampaignSummaryWithName (Aws::String &&value)
 
CampaignSummaryWithName (const char *value)
 
const Aws::StringGetCampaignArn () const
 
bool CampaignArnHasBeenSet () const
 
void SetCampaignArn (const Aws::String &value)
 
void SetCampaignArn (Aws::String &&value)
 
void SetCampaignArn (const char *value)
 
CampaignSummaryWithCampaignArn (const Aws::String &value)
 
CampaignSummaryWithCampaignArn (Aws::String &&value)
 
CampaignSummaryWithCampaignArn (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)
 
CampaignSummaryWithStatus (const Aws::String &value)
 
CampaignSummaryWithStatus (Aws::String &&value)
 
CampaignSummaryWithStatus (const char *value)
 
const Aws::Utils::DateTimeGetCreationDateTime () const
 
bool CreationDateTimeHasBeenSet () const
 
void SetCreationDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationDateTime (Aws::Utils::DateTime &&value)
 
CampaignSummaryWithCreationDateTime (const Aws::Utils::DateTime &value)
 
CampaignSummaryWithCreationDateTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedDateTime () const
 
bool LastUpdatedDateTimeHasBeenSet () const
 
void SetLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 
CampaignSummaryWithLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
CampaignSummaryWithLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
CampaignSummaryWithFailureReason (const Aws::String &value)
 
CampaignSummaryWithFailureReason (Aws::String &&value)
 
CampaignSummaryWithFailureReason (const char *value)
 

Detailed Description

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

See Also:

AWS API Reference

Definition at line 33 of file CampaignSummary.h.

Constructor & Destructor Documentation

◆ CampaignSummary() [1/2]

Aws::Personalize::Model::CampaignSummary::CampaignSummary ( )

◆ CampaignSummary() [2/2]

Aws::Personalize::Model::CampaignSummary::CampaignSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CampaignArnHasBeenSet()

bool Aws::Personalize::Model::CampaignSummary::CampaignArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 91 of file CampaignSummary.h.

◆ CreationDateTimeHasBeenSet()

bool Aws::Personalize::Model::CampaignSummary::CreationDateTimeHasBeenSet ( ) const
inline

The date and time (in Unix time) that the campaign was created.

Definition at line 197 of file CampaignSummary.h.

◆ FailureReasonHasBeenSet()

bool Aws::Personalize::Model::CampaignSummary::FailureReasonHasBeenSet ( ) const
inline

If a campaign fails, the reason behind the failure.

Definition at line 259 of file CampaignSummary.h.

◆ GetCampaignArn()

const Aws::String& Aws::Personalize::Model::CampaignSummary::GetCampaignArn ( ) const
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 86 of file CampaignSummary.h.

◆ GetCreationDateTime()

const Aws::Utils::DateTime& Aws::Personalize::Model::CampaignSummary::GetCreationDateTime ( ) const
inline

The date and time (in Unix time) that the campaign was created.

Definition at line 192 of file CampaignSummary.h.

◆ GetFailureReason()

const Aws::String& Aws::Personalize::Model::CampaignSummary::GetFailureReason ( ) const
inline

If a campaign fails, the reason behind the failure.

Definition at line 254 of file CampaignSummary.h.

◆ GetLastUpdatedDateTime()

const Aws::Utils::DateTime& Aws::Personalize::Model::CampaignSummary::GetLastUpdatedDateTime ( ) const
inline

The date and time (in Unix time) that the campaign was last updated.

Definition at line 223 of file CampaignSummary.h.

◆ GetName()

const Aws::String& Aws::Personalize::Model::CampaignSummary::GetName ( ) const
inline

The name of the campaign.

Definition at line 45 of file CampaignSummary.h.

◆ GetStatus()

const Aws::String& Aws::Personalize::Model::CampaignSummary::GetStatus ( ) const
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 130 of file CampaignSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Personalize::Model::CampaignSummary::Jsonize ( ) const

◆ LastUpdatedDateTimeHasBeenSet()

bool Aws::Personalize::Model::CampaignSummary::LastUpdatedDateTimeHasBeenSet ( ) const
inline

The date and time (in Unix time) that the campaign was last updated.

Definition at line 228 of file CampaignSummary.h.

◆ NameHasBeenSet()

bool Aws::Personalize::Model::CampaignSummary::NameHasBeenSet ( ) const
inline

The name of the campaign.

Definition at line 50 of file CampaignSummary.h.

◆ operator=()

CampaignSummary& Aws::Personalize::Model::CampaignSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCampaignArn() [1/3]

void Aws::Personalize::Model::CampaignSummary::SetCampaignArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 101 of file CampaignSummary.h.

◆ SetCampaignArn() [2/3]

void Aws::Personalize::Model::CampaignSummary::SetCampaignArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 96 of file CampaignSummary.h.

◆ SetCampaignArn() [3/3]

void Aws::Personalize::Model::CampaignSummary::SetCampaignArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 106 of file CampaignSummary.h.

◆ SetCreationDateTime() [1/2]

void Aws::Personalize::Model::CampaignSummary::SetCreationDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time (in Unix time) that the campaign was created.

Definition at line 207 of file CampaignSummary.h.

◆ SetCreationDateTime() [2/2]

void Aws::Personalize::Model::CampaignSummary::SetCreationDateTime ( const Aws::Utils::DateTime value)
inline

The date and time (in Unix time) that the campaign was created.

Definition at line 202 of file CampaignSummary.h.

◆ SetFailureReason() [1/3]

void Aws::Personalize::Model::CampaignSummary::SetFailureReason ( Aws::String &&  value)
inline

If a campaign fails, the reason behind the failure.

Definition at line 269 of file CampaignSummary.h.

◆ SetFailureReason() [2/3]

void Aws::Personalize::Model::CampaignSummary::SetFailureReason ( const Aws::String value)
inline

If a campaign fails, the reason behind the failure.

Definition at line 264 of file CampaignSummary.h.

◆ SetFailureReason() [3/3]

void Aws::Personalize::Model::CampaignSummary::SetFailureReason ( const char *  value)
inline

If a campaign fails, the reason behind the failure.

Definition at line 274 of file CampaignSummary.h.

◆ SetLastUpdatedDateTime() [1/2]

void Aws::Personalize::Model::CampaignSummary::SetLastUpdatedDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time (in Unix time) that the campaign was last updated.

Definition at line 238 of file CampaignSummary.h.

◆ SetLastUpdatedDateTime() [2/2]

void Aws::Personalize::Model::CampaignSummary::SetLastUpdatedDateTime ( const Aws::Utils::DateTime value)
inline

The date and time (in Unix time) that the campaign was last updated.

Definition at line 233 of file CampaignSummary.h.

◆ SetName() [1/3]

void Aws::Personalize::Model::CampaignSummary::SetName ( Aws::String &&  value)
inline

The name of the campaign.

Definition at line 60 of file CampaignSummary.h.

◆ SetName() [2/3]

void Aws::Personalize::Model::CampaignSummary::SetName ( const Aws::String value)
inline

The name of the campaign.

Definition at line 55 of file CampaignSummary.h.

◆ SetName() [3/3]

void Aws::Personalize::Model::CampaignSummary::SetName ( const char *  value)
inline

The name of the campaign.

Definition at line 65 of file CampaignSummary.h.

◆ SetStatus() [1/3]

void Aws::Personalize::Model::CampaignSummary::SetStatus ( Aws::String &&  value)
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 154 of file CampaignSummary.h.

◆ SetStatus() [2/3]

void Aws::Personalize::Model::CampaignSummary::SetStatus ( const Aws::String value)
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 146 of file CampaignSummary.h.

◆ SetStatus() [3/3]

void Aws::Personalize::Model::CampaignSummary::SetStatus ( const char *  value)
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 162 of file CampaignSummary.h.

◆ StatusHasBeenSet()

bool Aws::Personalize::Model::CampaignSummary::StatusHasBeenSet ( ) const
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 138 of file CampaignSummary.h.

◆ WithCampaignArn() [1/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithCampaignArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 116 of file CampaignSummary.h.

◆ WithCampaignArn() [2/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithCampaignArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 111 of file CampaignSummary.h.

◆ WithCampaignArn() [3/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithCampaignArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the campaign.

Definition at line 121 of file CampaignSummary.h.

◆ WithCreationDateTime() [1/2]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithCreationDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time (in Unix time) that the campaign was created.

Definition at line 217 of file CampaignSummary.h.

◆ WithCreationDateTime() [2/2]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithCreationDateTime ( const Aws::Utils::DateTime value)
inline

The date and time (in Unix time) that the campaign was created.

Definition at line 212 of file CampaignSummary.h.

◆ WithFailureReason() [1/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithFailureReason ( Aws::String &&  value)
inline

If a campaign fails, the reason behind the failure.

Definition at line 284 of file CampaignSummary.h.

◆ WithFailureReason() [2/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithFailureReason ( const Aws::String value)
inline

If a campaign fails, the reason behind the failure.

Definition at line 279 of file CampaignSummary.h.

◆ WithFailureReason() [3/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithFailureReason ( const char *  value)
inline

If a campaign fails, the reason behind the failure.

Definition at line 289 of file CampaignSummary.h.

◆ WithLastUpdatedDateTime() [1/2]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithLastUpdatedDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time (in Unix time) that the campaign was last updated.

Definition at line 248 of file CampaignSummary.h.

◆ WithLastUpdatedDateTime() [2/2]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithLastUpdatedDateTime ( const Aws::Utils::DateTime value)
inline

The date and time (in Unix time) that the campaign was last updated.

Definition at line 243 of file CampaignSummary.h.

◆ WithName() [1/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithName ( Aws::String &&  value)
inline

The name of the campaign.

Definition at line 75 of file CampaignSummary.h.

◆ WithName() [2/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithName ( const Aws::String value)
inline

The name of the campaign.

Definition at line 70 of file CampaignSummary.h.

◆ WithName() [3/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithName ( const char *  value)
inline

The name of the campaign.

Definition at line 80 of file CampaignSummary.h.

◆ WithStatus() [1/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithStatus ( Aws::String &&  value)
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 178 of file CampaignSummary.h.

◆ WithStatus() [2/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithStatus ( const Aws::String value)
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 170 of file CampaignSummary.h.

◆ WithStatus() [3/3]

CampaignSummary& Aws::Personalize::Model::CampaignSummary::WithStatus ( const char *  value)
inline

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

Definition at line 186 of file CampaignSummary.h.


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