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

#include <FacetResult.h>

Public Member Functions

 FacetResult ()
 
 FacetResult (Aws::Utils::Json::JsonView jsonValue)
 
FacetResultoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDocumentAttributeKey () const
 
bool DocumentAttributeKeyHasBeenSet () const
 
void SetDocumentAttributeKey (const Aws::String &value)
 
void SetDocumentAttributeKey (Aws::String &&value)
 
void SetDocumentAttributeKey (const char *value)
 
FacetResultWithDocumentAttributeKey (const Aws::String &value)
 
FacetResultWithDocumentAttributeKey (Aws::String &&value)
 
FacetResultWithDocumentAttributeKey (const char *value)
 
const DocumentAttributeValueTypeGetDocumentAttributeValueType () const
 
bool DocumentAttributeValueTypeHasBeenSet () const
 
void SetDocumentAttributeValueType (const DocumentAttributeValueType &value)
 
void SetDocumentAttributeValueType (DocumentAttributeValueType &&value)
 
FacetResultWithDocumentAttributeValueType (const DocumentAttributeValueType &value)
 
FacetResultWithDocumentAttributeValueType (DocumentAttributeValueType &&value)
 
const Aws::Vector< DocumentAttributeValueCountPair > & GetDocumentAttributeValueCountPairs () const
 
bool DocumentAttributeValueCountPairsHasBeenSet () const
 
void SetDocumentAttributeValueCountPairs (const Aws::Vector< DocumentAttributeValueCountPair > &value)
 
void SetDocumentAttributeValueCountPairs (Aws::Vector< DocumentAttributeValueCountPair > &&value)
 
FacetResultWithDocumentAttributeValueCountPairs (const Aws::Vector< DocumentAttributeValueCountPair > &value)
 
FacetResultWithDocumentAttributeValueCountPairs (Aws::Vector< DocumentAttributeValueCountPair > &&value)
 
FacetResultAddDocumentAttributeValueCountPairs (const DocumentAttributeValueCountPair &value)
 
FacetResultAddDocumentAttributeValueCountPairs (DocumentAttributeValueCountPair &&value)
 

Detailed Description

The facet values for the documents in the response.

See Also:

AWS API Reference

Definition at line 35 of file FacetResult.h.

Constructor & Destructor Documentation

◆ FacetResult() [1/2]

Aws::kendra::Model::FacetResult::FacetResult ( )

◆ FacetResult() [2/2]

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

Member Function Documentation

◆ AddDocumentAttributeValueCountPairs() [1/2]

FacetResult& Aws::kendra::Model::FacetResult::AddDocumentAttributeValueCountPairs ( const DocumentAttributeValueCountPair value)
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 170 of file FacetResult.h.

◆ AddDocumentAttributeValueCountPairs() [2/2]

FacetResult& Aws::kendra::Model::FacetResult::AddDocumentAttributeValueCountPairs ( DocumentAttributeValueCountPair &&  value)
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 176 of file FacetResult.h.

◆ DocumentAttributeKeyHasBeenSet()

bool Aws::kendra::Model::FacetResult::DocumentAttributeKeyHasBeenSet ( ) const
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 54 of file FacetResult.h.

◆ DocumentAttributeValueCountPairsHasBeenSet()

bool Aws::kendra::Model::FacetResult::DocumentAttributeValueCountPairsHasBeenSet ( ) const
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 140 of file FacetResult.h.

◆ DocumentAttributeValueTypeHasBeenSet()

bool Aws::kendra::Model::FacetResult::DocumentAttributeValueTypeHasBeenSet ( ) const
inline

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Definition at line 103 of file FacetResult.h.

◆ GetDocumentAttributeKey()

const Aws::String& Aws::kendra::Model::FacetResult::GetDocumentAttributeKey ( ) const
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 48 of file FacetResult.h.

◆ GetDocumentAttributeValueCountPairs()

const Aws::Vector<DocumentAttributeValueCountPair>& Aws::kendra::Model::FacetResult::GetDocumentAttributeValueCountPairs ( ) const
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 134 of file FacetResult.h.

◆ GetDocumentAttributeValueType()

const DocumentAttributeValueType& Aws::kendra::Model::FacetResult::GetDocumentAttributeValueType ( ) const
inline

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Definition at line 97 of file FacetResult.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetDocumentAttributeKey() [1/3]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeKey ( Aws::String &&  value)
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 66 of file FacetResult.h.

◆ SetDocumentAttributeKey() [2/3]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeKey ( const Aws::String value)
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 60 of file FacetResult.h.

◆ SetDocumentAttributeKey() [3/3]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeKey ( const char *  value)
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 72 of file FacetResult.h.

◆ SetDocumentAttributeValueCountPairs() [1/2]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeValueCountPairs ( Aws::Vector< DocumentAttributeValueCountPair > &&  value)
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 152 of file FacetResult.h.

◆ SetDocumentAttributeValueCountPairs() [2/2]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeValueCountPairs ( const Aws::Vector< DocumentAttributeValueCountPair > &  value)
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 146 of file FacetResult.h.

◆ SetDocumentAttributeValueType() [1/2]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeValueType ( const DocumentAttributeValueType value)
inline

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Definition at line 109 of file FacetResult.h.

◆ SetDocumentAttributeValueType() [2/2]

void Aws::kendra::Model::FacetResult::SetDocumentAttributeValueType ( DocumentAttributeValueType &&  value)
inline

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Definition at line 115 of file FacetResult.h.

◆ WithDocumentAttributeKey() [1/3]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeKey ( Aws::String &&  value)
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 84 of file FacetResult.h.

◆ WithDocumentAttributeKey() [2/3]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeKey ( const Aws::String value)
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 78 of file FacetResult.h.

◆ WithDocumentAttributeKey() [3/3]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeKey ( const char *  value)
inline

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Definition at line 90 of file FacetResult.h.

◆ WithDocumentAttributeValueCountPairs() [1/2]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeValueCountPairs ( Aws::Vector< DocumentAttributeValueCountPair > &&  value)
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 164 of file FacetResult.h.

◆ WithDocumentAttributeValueCountPairs() [2/2]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeValueCountPairs ( const Aws::Vector< DocumentAttributeValueCountPair > &  value)
inline

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Definition at line 158 of file FacetResult.h.

◆ WithDocumentAttributeValueType() [1/2]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeValueType ( const DocumentAttributeValueType value)
inline

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Definition at line 121 of file FacetResult.h.

◆ WithDocumentAttributeValueType() [2/2]

FacetResult& Aws::kendra::Model::FacetResult::WithDocumentAttributeValueType ( DocumentAttributeValueType &&  value)
inline

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Definition at line 127 of file FacetResult.h.


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