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

#include <Filter.h>

Public Member Functions

 Filter ()
 
 Filter (Aws::Utils::Json::JsonView jsonValue)
 
Filteroperator= (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)
 
FilterWithName (const Aws::String &value)
 
FilterWithName (Aws::String &&value)
 
FilterWithName (const char *value)
 
const Aws::StringGetFilterArn () const
 
bool FilterArnHasBeenSet () const
 
void SetFilterArn (const Aws::String &value)
 
void SetFilterArn (Aws::String &&value)
 
void SetFilterArn (const char *value)
 
FilterWithFilterArn (const Aws::String &value)
 
FilterWithFilterArn (Aws::String &&value)
 
FilterWithFilterArn (const char *value)
 
const Aws::Utils::DateTimeGetCreationDateTime () const
 
bool CreationDateTimeHasBeenSet () const
 
void SetCreationDateTime (const Aws::Utils::DateTime &value)
 
void SetCreationDateTime (Aws::Utils::DateTime &&value)
 
FilterWithCreationDateTime (const Aws::Utils::DateTime &value)
 
FilterWithCreationDateTime (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)
 
FilterWithLastUpdatedDateTime (const Aws::Utils::DateTime &value)
 
FilterWithLastUpdatedDateTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDatasetGroupArn () const
 
bool DatasetGroupArnHasBeenSet () const
 
void SetDatasetGroupArn (const Aws::String &value)
 
void SetDatasetGroupArn (Aws::String &&value)
 
void SetDatasetGroupArn (const char *value)
 
FilterWithDatasetGroupArn (const Aws::String &value)
 
FilterWithDatasetGroupArn (Aws::String &&value)
 
FilterWithDatasetGroupArn (const char *value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
FilterWithFailureReason (const Aws::String &value)
 
FilterWithFailureReason (Aws::String &&value)
 
FilterWithFailureReason (const char *value)
 
const Aws::StringGetFilterExpression () const
 
bool FilterExpressionHasBeenSet () const
 
void SetFilterExpression (const Aws::String &value)
 
void SetFilterExpression (Aws::String &&value)
 
void SetFilterExpression (const char *value)
 
FilterWithFilterExpression (const Aws::String &value)
 
FilterWithFilterExpression (Aws::String &&value)
 
FilterWithFilterExpression (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)
 
FilterWithStatus (const Aws::String &value)
 
FilterWithStatus (Aws::String &&value)
 
FilterWithStatus (const char *value)
 

Detailed Description

Contains information on a recommendation filter, including its ARN, status, and filter expression.

See Also:

AWS API Reference

Definition at line 33 of file Filter.h.

Constructor & Destructor Documentation

◆ Filter() [1/2]

Aws::Personalize::Model::Filter::Filter ( )

◆ Filter() [2/2]

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

Member Function Documentation

◆ CreationDateTimeHasBeenSet()

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

The time at which the filter was created.

Definition at line 132 of file Filter.h.

◆ DatasetGroupArnHasBeenSet()

bool Aws::Personalize::Model::Filter::DatasetGroupArnHasBeenSet ( ) const
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 194 of file Filter.h.

◆ FailureReasonHasBeenSet()

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

If the filter failed, the reason for its failure.

Definition at line 235 of file Filter.h.

◆ FilterArnHasBeenSet()

bool Aws::Personalize::Model::Filter::FilterArnHasBeenSet ( ) const
inline

The ARN of the filter.

Definition at line 91 of file Filter.h.

◆ FilterExpressionHasBeenSet()

bool Aws::Personalize::Model::Filter::FilterExpressionHasBeenSet ( ) const
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 282 of file Filter.h.

◆ GetCreationDateTime()

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

The time at which the filter was created.

Definition at line 127 of file Filter.h.

◆ GetDatasetGroupArn()

const Aws::String& Aws::Personalize::Model::Filter::GetDatasetGroupArn ( ) const
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 189 of file Filter.h.

◆ GetFailureReason()

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

If the filter failed, the reason for its failure.

Definition at line 230 of file Filter.h.

◆ GetFilterArn()

const Aws::String& Aws::Personalize::Model::Filter::GetFilterArn ( ) const
inline

The ARN of the filter.

Definition at line 86 of file Filter.h.

◆ GetFilterExpression()

const Aws::String& Aws::Personalize::Model::Filter::GetFilterExpression ( ) const
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 274 of file Filter.h.

◆ GetLastUpdatedDateTime()

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

The time at which the filter was last updated.

Definition at line 158 of file Filter.h.

◆ GetName()

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

The name of the filter.

Definition at line 45 of file Filter.h.

◆ GetStatus()

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

The status of the filter.

Definition at line 336 of file Filter.h.

◆ Jsonize()

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

◆ LastUpdatedDateTimeHasBeenSet()

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

The time at which the filter was last updated.

Definition at line 163 of file Filter.h.

◆ NameHasBeenSet()

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

The name of the filter.

Definition at line 50 of file Filter.h.

◆ operator=()

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

◆ SetCreationDateTime() [1/2]

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

The time at which the filter was created.

Definition at line 142 of file Filter.h.

◆ SetCreationDateTime() [2/2]

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

The time at which the filter was created.

Definition at line 137 of file Filter.h.

◆ SetDatasetGroupArn() [1/3]

void Aws::Personalize::Model::Filter::SetDatasetGroupArn ( Aws::String &&  value)
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 204 of file Filter.h.

◆ SetDatasetGroupArn() [2/3]

void Aws::Personalize::Model::Filter::SetDatasetGroupArn ( const Aws::String value)
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 199 of file Filter.h.

◆ SetDatasetGroupArn() [3/3]

void Aws::Personalize::Model::Filter::SetDatasetGroupArn ( const char *  value)
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 209 of file Filter.h.

◆ SetFailureReason() [1/3]

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

If the filter failed, the reason for its failure.

Definition at line 245 of file Filter.h.

◆ SetFailureReason() [2/3]

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

If the filter failed, the reason for its failure.

Definition at line 240 of file Filter.h.

◆ SetFailureReason() [3/3]

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

If the filter failed, the reason for its failure.

Definition at line 250 of file Filter.h.

◆ SetFilterArn() [1/3]

void Aws::Personalize::Model::Filter::SetFilterArn ( Aws::String &&  value)
inline

The ARN of the filter.

Definition at line 101 of file Filter.h.

◆ SetFilterArn() [2/3]

void Aws::Personalize::Model::Filter::SetFilterArn ( const Aws::String value)
inline

The ARN of the filter.

Definition at line 96 of file Filter.h.

◆ SetFilterArn() [3/3]

void Aws::Personalize::Model::Filter::SetFilterArn ( const char *  value)
inline

The ARN of the filter.

Definition at line 106 of file Filter.h.

◆ SetFilterExpression() [1/3]

void Aws::Personalize::Model::Filter::SetFilterExpression ( Aws::String &&  value)
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 298 of file Filter.h.

◆ SetFilterExpression() [2/3]

void Aws::Personalize::Model::Filter::SetFilterExpression ( const Aws::String value)
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 290 of file Filter.h.

◆ SetFilterExpression() [3/3]

void Aws::Personalize::Model::Filter::SetFilterExpression ( const char *  value)
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 306 of file Filter.h.

◆ SetLastUpdatedDateTime() [1/2]

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

The time at which the filter was last updated.

Definition at line 173 of file Filter.h.

◆ SetLastUpdatedDateTime() [2/2]

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

The time at which the filter was last updated.

Definition at line 168 of file Filter.h.

◆ SetName() [1/3]

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

The name of the filter.

Definition at line 60 of file Filter.h.

◆ SetName() [2/3]

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

The name of the filter.

Definition at line 55 of file Filter.h.

◆ SetName() [3/3]

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

The name of the filter.

Definition at line 65 of file Filter.h.

◆ SetStatus() [1/3]

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

The status of the filter.

Definition at line 351 of file Filter.h.

◆ SetStatus() [2/3]

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

The status of the filter.

Definition at line 346 of file Filter.h.

◆ SetStatus() [3/3]

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

The status of the filter.

Definition at line 356 of file Filter.h.

◆ StatusHasBeenSet()

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

The status of the filter.

Definition at line 341 of file Filter.h.

◆ WithCreationDateTime() [1/2]

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

The time at which the filter was created.

Definition at line 152 of file Filter.h.

◆ WithCreationDateTime() [2/2]

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

The time at which the filter was created.

Definition at line 147 of file Filter.h.

◆ WithDatasetGroupArn() [1/3]

Filter& Aws::Personalize::Model::Filter::WithDatasetGroupArn ( Aws::String &&  value)
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 219 of file Filter.h.

◆ WithDatasetGroupArn() [2/3]

Filter& Aws::Personalize::Model::Filter::WithDatasetGroupArn ( const Aws::String value)
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 214 of file Filter.h.

◆ WithDatasetGroupArn() [3/3]

Filter& Aws::Personalize::Model::Filter::WithDatasetGroupArn ( const char *  value)
inline

The ARN of the dataset group to which the filter belongs.

Definition at line 224 of file Filter.h.

◆ WithFailureReason() [1/3]

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

If the filter failed, the reason for its failure.

Definition at line 260 of file Filter.h.

◆ WithFailureReason() [2/3]

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

If the filter failed, the reason for its failure.

Definition at line 255 of file Filter.h.

◆ WithFailureReason() [3/3]

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

If the filter failed, the reason for its failure.

Definition at line 265 of file Filter.h.

◆ WithFilterArn() [1/3]

Filter& Aws::Personalize::Model::Filter::WithFilterArn ( Aws::String &&  value)
inline

The ARN of the filter.

Definition at line 116 of file Filter.h.

◆ WithFilterArn() [2/3]

Filter& Aws::Personalize::Model::Filter::WithFilterArn ( const Aws::String value)
inline

The ARN of the filter.

Definition at line 111 of file Filter.h.

◆ WithFilterArn() [3/3]

Filter& Aws::Personalize::Model::Filter::WithFilterArn ( const char *  value)
inline

The ARN of the filter.

Definition at line 121 of file Filter.h.

◆ WithFilterExpression() [1/3]

Filter& Aws::Personalize::Model::Filter::WithFilterExpression ( Aws::String &&  value)
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 322 of file Filter.h.

◆ WithFilterExpression() [2/3]

Filter& Aws::Personalize::Model::Filter::WithFilterExpression ( const Aws::String value)
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 314 of file Filter.h.

◆ WithFilterExpression() [3/3]

Filter& Aws::Personalize::Model::Filter::WithFilterExpression ( const char *  value)
inline

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

Definition at line 330 of file Filter.h.

◆ WithLastUpdatedDateTime() [1/2]

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

The time at which the filter was last updated.

Definition at line 183 of file Filter.h.

◆ WithLastUpdatedDateTime() [2/2]

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

The time at which the filter was last updated.

Definition at line 178 of file Filter.h.

◆ WithName() [1/3]

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

The name of the filter.

Definition at line 75 of file Filter.h.

◆ WithName() [2/3]

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

The name of the filter.

Definition at line 70 of file Filter.h.

◆ WithName() [3/3]

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

The name of the filter.

Definition at line 80 of file Filter.h.

◆ WithStatus() [1/3]

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

The status of the filter.

Definition at line 366 of file Filter.h.

◆ WithStatus() [2/3]

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

The status of the filter.

Definition at line 361 of file Filter.h.

◆ WithStatus() [3/3]

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

The status of the filter.

Definition at line 371 of file Filter.h.


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