AWS SDK for C++  1.9.128
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::AttributeFilter Class Reference

#include <AttributeFilter.h>

Public Member Functions

 AttributeFilter ()
 
 AttributeFilter (Aws::Utils::Json::JsonView jsonValue)
 
AttributeFilteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< AttributeFilter > & GetAndAllFilters () const
 
bool AndAllFiltersHasBeenSet () const
 
void SetAndAllFilters (const Aws::Vector< AttributeFilter > &value)
 
void SetAndAllFilters (Aws::Vector< AttributeFilter > &&value)
 
AttributeFilterWithAndAllFilters (const Aws::Vector< AttributeFilter > &value)
 
AttributeFilterWithAndAllFilters (Aws::Vector< AttributeFilter > &&value)
 
AttributeFilterAddAndAllFilters (const AttributeFilter &value)
 
AttributeFilterAddAndAllFilters (AttributeFilter &&value)
 
const Aws::Vector< AttributeFilter > & GetOrAllFilters () const
 
bool OrAllFiltersHasBeenSet () const
 
void SetOrAllFilters (const Aws::Vector< AttributeFilter > &value)
 
void SetOrAllFilters (Aws::Vector< AttributeFilter > &&value)
 
AttributeFilterWithOrAllFilters (const Aws::Vector< AttributeFilter > &value)
 
AttributeFilterWithOrAllFilters (Aws::Vector< AttributeFilter > &&value)
 
AttributeFilterAddOrAllFilters (const AttributeFilter &value)
 
AttributeFilterAddOrAllFilters (AttributeFilter &&value)
 
const AttributeFilterGetNotFilter () const
 
bool NotFilterHasBeenSet () const
 
void SetNotFilter (const AttributeFilter &value)
 
void SetNotFilter (AttributeFilter &&value)
 
AttributeFilterWithNotFilter (const AttributeFilter &value)
 
AttributeFilterWithNotFilter (AttributeFilter &&value)
 
const DocumentAttributeGetEqualsTo () const
 
bool EqualsToHasBeenSet () const
 
void SetEqualsTo (const DocumentAttribute &value)
 
void SetEqualsTo (DocumentAttribute &&value)
 
AttributeFilterWithEqualsTo (const DocumentAttribute &value)
 
AttributeFilterWithEqualsTo (DocumentAttribute &&value)
 
const DocumentAttributeGetContainsAll () const
 
bool ContainsAllHasBeenSet () const
 
void SetContainsAll (const DocumentAttribute &value)
 
void SetContainsAll (DocumentAttribute &&value)
 
AttributeFilterWithContainsAll (const DocumentAttribute &value)
 
AttributeFilterWithContainsAll (DocumentAttribute &&value)
 
const DocumentAttributeGetContainsAny () const
 
bool ContainsAnyHasBeenSet () const
 
void SetContainsAny (const DocumentAttribute &value)
 
void SetContainsAny (DocumentAttribute &&value)
 
AttributeFilterWithContainsAny (const DocumentAttribute &value)
 
AttributeFilterWithContainsAny (DocumentAttribute &&value)
 
const DocumentAttributeGetGreaterThan () const
 
bool GreaterThanHasBeenSet () const
 
void SetGreaterThan (const DocumentAttribute &value)
 
void SetGreaterThan (DocumentAttribute &&value)
 
AttributeFilterWithGreaterThan (const DocumentAttribute &value)
 
AttributeFilterWithGreaterThan (DocumentAttribute &&value)
 
const DocumentAttributeGetGreaterThanOrEquals () const
 
bool GreaterThanOrEqualsHasBeenSet () const
 
void SetGreaterThanOrEquals (const DocumentAttribute &value)
 
void SetGreaterThanOrEquals (DocumentAttribute &&value)
 
AttributeFilterWithGreaterThanOrEquals (const DocumentAttribute &value)
 
AttributeFilterWithGreaterThanOrEquals (DocumentAttribute &&value)
 
const DocumentAttributeGetLessThan () const
 
bool LessThanHasBeenSet () const
 
void SetLessThan (const DocumentAttribute &value)
 
void SetLessThan (DocumentAttribute &&value)
 
AttributeFilterWithLessThan (const DocumentAttribute &value)
 
AttributeFilterWithLessThan (DocumentAttribute &&value)
 
const DocumentAttributeGetLessThanOrEquals () const
 
bool LessThanOrEqualsHasBeenSet () const
 
void SetLessThanOrEquals (const DocumentAttribute &value)
 
void SetLessThanOrEquals (DocumentAttribute &&value)
 
AttributeFilterWithLessThanOrEquals (const DocumentAttribute &value)
 
AttributeFilterWithLessThanOrEquals (DocumentAttribute &&value)
 

Detailed Description

Provides filtering the query results based on document attributes.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

  1. <OrAllFilters>

  2. <EqualTo>

If you use more than 2 layers, you receive a ValidationException exception with the message "<code>AttributeFilter</code> cannot have a depth of more than 2."

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message "<code>AttributeFilter</code> cannot have a length of more than 10".

See Also:

AWS API Reference

Definition at line 44 of file AttributeFilter.h.

Constructor & Destructor Documentation

◆ AttributeFilter() [1/2]

Aws::kendra::Model::AttributeFilter::AttributeFilter ( )

◆ AttributeFilter() [2/2]

Aws::kendra::Model::AttributeFilter::AttributeFilter ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAndAllFilters() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::AddAndAllFilters ( AttributeFilter &&  value)
inline

Performs a logical AND operation on all supplied filters.

Definition at line 91 of file AttributeFilter.h.

◆ AddAndAllFilters() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::AddAndAllFilters ( const AttributeFilter value)
inline

Performs a logical AND operation on all supplied filters.

Definition at line 86 of file AttributeFilter.h.

◆ AddOrAllFilters() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::AddOrAllFilters ( AttributeFilter &&  value)
inline

Performs a logical OR operation on all supplied filters.

Definition at line 132 of file AttributeFilter.h.

◆ AddOrAllFilters() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::AddOrAllFilters ( const AttributeFilter value)
inline

Performs a logical OR operation on all supplied filters.

Definition at line 127 of file AttributeFilter.h.

◆ AndAllFiltersHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::AndAllFiltersHasBeenSet ( ) const
inline

Performs a logical AND operation on all supplied filters.

Definition at line 61 of file AttributeFilter.h.

◆ ContainsAllHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::ContainsAllHasBeenSet ( ) const
inline

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 209 of file AttributeFilter.h.

◆ ContainsAnyHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::ContainsAnyHasBeenSet ( ) const
inline

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 252 of file AttributeFilter.h.

◆ EqualsToHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::EqualsToHasBeenSet ( ) const
inline

Performs an equals operation on two document attributes.

Definition at line 174 of file AttributeFilter.h.

◆ GetAndAllFilters()

const Aws::Vector<AttributeFilter>& Aws::kendra::Model::AttributeFilter::GetAndAllFilters ( ) const
inline

Performs a logical AND operation on all supplied filters.

Definition at line 56 of file AttributeFilter.h.

◆ GetContainsAll()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetContainsAll ( ) const
inline

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 202 of file AttributeFilter.h.

◆ GetContainsAny()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetContainsAny ( ) const
inline

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 245 of file AttributeFilter.h.

◆ GetEqualsTo()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetEqualsTo ( ) const
inline

Performs an equals operation on two document attributes.

Definition at line 169 of file AttributeFilter.h.

◆ GetGreaterThan()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetGreaterThan ( ) const
inline

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 287 of file AttributeFilter.h.

◆ GetGreaterThanOrEquals()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetGreaterThanOrEquals ( ) const
inline

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 324 of file AttributeFilter.h.

◆ GetLessThan()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetLessThan ( ) const
inline

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 361 of file AttributeFilter.h.

◆ GetLessThanOrEquals()

const DocumentAttribute& Aws::kendra::Model::AttributeFilter::GetLessThanOrEquals ( ) const
inline

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 398 of file AttributeFilter.h.

◆ GetNotFilter()

const AttributeFilter& Aws::kendra::Model::AttributeFilter::GetNotFilter ( ) const
inline

Performs a logical NOT operation on all supplied filters.

Definition at line 138 of file AttributeFilter.h.

◆ GetOrAllFilters()

const Aws::Vector<AttributeFilter>& Aws::kendra::Model::AttributeFilter::GetOrAllFilters ( ) const
inline

Performs a logical OR operation on all supplied filters.

Definition at line 97 of file AttributeFilter.h.

◆ GreaterThanHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::GreaterThanHasBeenSet ( ) const
inline

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 293 of file AttributeFilter.h.

◆ GreaterThanOrEqualsHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::GreaterThanOrEqualsHasBeenSet ( ) const
inline

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 330 of file AttributeFilter.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::AttributeFilter::Jsonize ( ) const

◆ LessThanHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::LessThanHasBeenSet ( ) const
inline

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 367 of file AttributeFilter.h.

◆ LessThanOrEqualsHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::LessThanOrEqualsHasBeenSet ( ) const
inline

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 404 of file AttributeFilter.h.

◆ NotFilterHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::NotFilterHasBeenSet ( ) const
inline

Performs a logical NOT operation on all supplied filters.

Definition at line 143 of file AttributeFilter.h.

◆ operator=()

AttributeFilter& Aws::kendra::Model::AttributeFilter::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OrAllFiltersHasBeenSet()

bool Aws::kendra::Model::AttributeFilter::OrAllFiltersHasBeenSet ( ) const
inline

Performs a logical OR operation on all supplied filters.

Definition at line 102 of file AttributeFilter.h.

◆ SetAndAllFilters() [1/2]

void Aws::kendra::Model::AttributeFilter::SetAndAllFilters ( Aws::Vector< AttributeFilter > &&  value)
inline

Performs a logical AND operation on all supplied filters.

Definition at line 71 of file AttributeFilter.h.

◆ SetAndAllFilters() [2/2]

void Aws::kendra::Model::AttributeFilter::SetAndAllFilters ( const Aws::Vector< AttributeFilter > &  value)
inline

Performs a logical AND operation on all supplied filters.

Definition at line 66 of file AttributeFilter.h.

◆ SetContainsAll() [1/2]

void Aws::kendra::Model::AttributeFilter::SetContainsAll ( const DocumentAttribute value)
inline

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 216 of file AttributeFilter.h.

◆ SetContainsAll() [2/2]

void Aws::kendra::Model::AttributeFilter::SetContainsAll ( DocumentAttribute &&  value)
inline

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 223 of file AttributeFilter.h.

◆ SetContainsAny() [1/2]

void Aws::kendra::Model::AttributeFilter::SetContainsAny ( const DocumentAttribute value)
inline

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 259 of file AttributeFilter.h.

◆ SetContainsAny() [2/2]

void Aws::kendra::Model::AttributeFilter::SetContainsAny ( DocumentAttribute &&  value)
inline

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 266 of file AttributeFilter.h.

◆ SetEqualsTo() [1/2]

void Aws::kendra::Model::AttributeFilter::SetEqualsTo ( const DocumentAttribute value)
inline

Performs an equals operation on two document attributes.

Definition at line 179 of file AttributeFilter.h.

◆ SetEqualsTo() [2/2]

void Aws::kendra::Model::AttributeFilter::SetEqualsTo ( DocumentAttribute &&  value)
inline

Performs an equals operation on two document attributes.

Definition at line 184 of file AttributeFilter.h.

◆ SetGreaterThan() [1/2]

void Aws::kendra::Model::AttributeFilter::SetGreaterThan ( const DocumentAttribute value)
inline

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 299 of file AttributeFilter.h.

◆ SetGreaterThan() [2/2]

void Aws::kendra::Model::AttributeFilter::SetGreaterThan ( DocumentAttribute &&  value)
inline

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 305 of file AttributeFilter.h.

◆ SetGreaterThanOrEquals() [1/2]

void Aws::kendra::Model::AttributeFilter::SetGreaterThanOrEquals ( const DocumentAttribute value)
inline

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 336 of file AttributeFilter.h.

◆ SetGreaterThanOrEquals() [2/2]

void Aws::kendra::Model::AttributeFilter::SetGreaterThanOrEquals ( DocumentAttribute &&  value)
inline

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 342 of file AttributeFilter.h.

◆ SetLessThan() [1/2]

void Aws::kendra::Model::AttributeFilter::SetLessThan ( const DocumentAttribute value)
inline

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 373 of file AttributeFilter.h.

◆ SetLessThan() [2/2]

void Aws::kendra::Model::AttributeFilter::SetLessThan ( DocumentAttribute &&  value)
inline

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 379 of file AttributeFilter.h.

◆ SetLessThanOrEquals() [1/2]

void Aws::kendra::Model::AttributeFilter::SetLessThanOrEquals ( const DocumentAttribute value)
inline

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 410 of file AttributeFilter.h.

◆ SetLessThanOrEquals() [2/2]

void Aws::kendra::Model::AttributeFilter::SetLessThanOrEquals ( DocumentAttribute &&  value)
inline

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 416 of file AttributeFilter.h.

◆ SetNotFilter() [1/2]

void Aws::kendra::Model::AttributeFilter::SetNotFilter ( AttributeFilter &&  value)
inline

Performs a logical NOT operation on all supplied filters.

Definition at line 153 of file AttributeFilter.h.

◆ SetNotFilter() [2/2]

void Aws::kendra::Model::AttributeFilter::SetNotFilter ( const AttributeFilter value)
inline

Performs a logical NOT operation on all supplied filters.

Definition at line 148 of file AttributeFilter.h.

◆ SetOrAllFilters() [1/2]

void Aws::kendra::Model::AttributeFilter::SetOrAllFilters ( Aws::Vector< AttributeFilter > &&  value)
inline

Performs a logical OR operation on all supplied filters.

Definition at line 112 of file AttributeFilter.h.

◆ SetOrAllFilters() [2/2]

void Aws::kendra::Model::AttributeFilter::SetOrAllFilters ( const Aws::Vector< AttributeFilter > &  value)
inline

Performs a logical OR operation on all supplied filters.

Definition at line 107 of file AttributeFilter.h.

◆ WithAndAllFilters() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithAndAllFilters ( Aws::Vector< AttributeFilter > &&  value)
inline

Performs a logical AND operation on all supplied filters.

Definition at line 81 of file AttributeFilter.h.

◆ WithAndAllFilters() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithAndAllFilters ( const Aws::Vector< AttributeFilter > &  value)
inline

Performs a logical AND operation on all supplied filters.

Definition at line 76 of file AttributeFilter.h.

◆ WithContainsAll() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithContainsAll ( const DocumentAttribute value)
inline

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 230 of file AttributeFilter.h.

◆ WithContainsAll() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithContainsAll ( DocumentAttribute &&  value)
inline

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 237 of file AttributeFilter.h.

◆ WithContainsAny() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithContainsAny ( const DocumentAttribute value)
inline

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 273 of file AttributeFilter.h.

◆ WithContainsAny() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithContainsAny ( DocumentAttribute &&  value)
inline

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Definition at line 280 of file AttributeFilter.h.

◆ WithEqualsTo() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithEqualsTo ( const DocumentAttribute value)
inline

Performs an equals operation on two document attributes.

Definition at line 189 of file AttributeFilter.h.

◆ WithEqualsTo() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithEqualsTo ( DocumentAttribute &&  value)
inline

Performs an equals operation on two document attributes.

Definition at line 194 of file AttributeFilter.h.

◆ WithGreaterThan() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithGreaterThan ( const DocumentAttribute value)
inline

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 311 of file AttributeFilter.h.

◆ WithGreaterThan() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithGreaterThan ( DocumentAttribute &&  value)
inline

Performs a greater than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 317 of file AttributeFilter.h.

◆ WithGreaterThanOrEquals() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithGreaterThanOrEquals ( const DocumentAttribute value)
inline

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 348 of file AttributeFilter.h.

◆ WithGreaterThanOrEquals() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithGreaterThanOrEquals ( DocumentAttribute &&  value)
inline

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 354 of file AttributeFilter.h.

◆ WithLessThan() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithLessThan ( const DocumentAttribute value)
inline

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 385 of file AttributeFilter.h.

◆ WithLessThan() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithLessThan ( DocumentAttribute &&  value)
inline

Performs a less than operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 391 of file AttributeFilter.h.

◆ WithLessThanOrEquals() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithLessThanOrEquals ( const DocumentAttribute value)
inline

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 422 of file AttributeFilter.h.

◆ WithLessThanOrEquals() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithLessThanOrEquals ( DocumentAttribute &&  value)
inline

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Date or Long.

Definition at line 428 of file AttributeFilter.h.

◆ WithNotFilter() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithNotFilter ( AttributeFilter &&  value)
inline

Performs a logical NOT operation on all supplied filters.

Definition at line 163 of file AttributeFilter.h.

◆ WithNotFilter() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithNotFilter ( const AttributeFilter value)
inline

Performs a logical NOT operation on all supplied filters.

Definition at line 158 of file AttributeFilter.h.

◆ WithOrAllFilters() [1/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithOrAllFilters ( Aws::Vector< AttributeFilter > &&  value)
inline

Performs a logical OR operation on all supplied filters.

Definition at line 122 of file AttributeFilter.h.

◆ WithOrAllFilters() [2/2]

AttributeFilter& Aws::kendra::Model::AttributeFilter::WithOrAllFilters ( const Aws::Vector< AttributeFilter > &  value)
inline

Performs a logical OR operation on all supplied filters.

Definition at line 117 of file AttributeFilter.h.


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