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

#include <QueryResult.h>

Public Member Functions

 QueryResult ()
 
 QueryResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
QueryResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetQueryId () const
 
void SetQueryId (const Aws::String &value)
 
void SetQueryId (Aws::String &&value)
 
void SetQueryId (const char *value)
 
QueryResultWithQueryId (const Aws::String &value)
 
QueryResultWithQueryId (Aws::String &&value)
 
QueryResultWithQueryId (const char *value)
 
const Aws::Vector< QueryResultItem > & GetResultItems () const
 
void SetResultItems (const Aws::Vector< QueryResultItem > &value)
 
void SetResultItems (Aws::Vector< QueryResultItem > &&value)
 
QueryResultWithResultItems (const Aws::Vector< QueryResultItem > &value)
 
QueryResultWithResultItems (Aws::Vector< QueryResultItem > &&value)
 
QueryResultAddResultItems (const QueryResultItem &value)
 
QueryResultAddResultItems (QueryResultItem &&value)
 
const Aws::Vector< FacetResult > & GetFacetResults () const
 
void SetFacetResults (const Aws::Vector< FacetResult > &value)
 
void SetFacetResults (Aws::Vector< FacetResult > &&value)
 
QueryResultWithFacetResults (const Aws::Vector< FacetResult > &value)
 
QueryResultWithFacetResults (Aws::Vector< FacetResult > &&value)
 
QueryResultAddFacetResults (const FacetResult &value)
 
QueryResultAddFacetResults (FacetResult &&value)
 
int GetTotalNumberOfResults () const
 
void SetTotalNumberOfResults (int value)
 
QueryResultWithTotalNumberOfResults (int value)
 

Detailed Description

Definition at line 30 of file QueryResult.h.

Constructor & Destructor Documentation

◆ QueryResult() [1/2]

Aws::kendra::Model::QueryResult::QueryResult ( )

◆ QueryResult() [2/2]

Aws::kendra::Model::QueryResult::QueryResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddFacetResults() [1/2]

QueryResult& Aws::kendra::Model::QueryResult::AddFacetResults ( const FacetResult value)
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 157 of file QueryResult.h.

◆ AddFacetResults() [2/2]

QueryResult& Aws::kendra::Model::QueryResult::AddFacetResults ( FacetResult &&  value)
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 164 of file QueryResult.h.

◆ AddResultItems() [1/2]

QueryResult& Aws::kendra::Model::QueryResult::AddResultItems ( const QueryResultItem value)
inline

The results of the search.

Definition at line 109 of file QueryResult.h.

◆ AddResultItems() [2/2]

QueryResult& Aws::kendra::Model::QueryResult::AddResultItems ( QueryResultItem &&  value)
inline

The results of the search.

Definition at line 114 of file QueryResult.h.

◆ GetFacetResults()

const Aws::Vector<FacetResult>& Aws::kendra::Model::QueryResult::GetFacetResults ( ) const
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 122 of file QueryResult.h.

◆ GetQueryId()

const Aws::String& Aws::kendra::Model::QueryResult::GetQueryId ( ) const
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 42 of file QueryResult.h.

◆ GetResultItems()

const Aws::Vector<QueryResultItem>& Aws::kendra::Model::QueryResult::GetResultItems ( ) const
inline

The results of the search.

Definition at line 84 of file QueryResult.h.

◆ GetTotalNumberOfResults()

int Aws::kendra::Model::QueryResult::GetTotalNumberOfResults ( ) const
inline

The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Definition at line 172 of file QueryResult.h.

◆ operator=()

QueryResult& Aws::kendra::Model::QueryResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetFacetResults() [1/2]

void Aws::kendra::Model::QueryResult::SetFacetResults ( Aws::Vector< FacetResult > &&  value)
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 136 of file QueryResult.h.

◆ SetFacetResults() [2/2]

void Aws::kendra::Model::QueryResult::SetFacetResults ( const Aws::Vector< FacetResult > &  value)
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 129 of file QueryResult.h.

◆ SetQueryId() [1/3]

void Aws::kendra::Model::QueryResult::SetQueryId ( Aws::String &&  value)
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 54 of file QueryResult.h.

◆ SetQueryId() [2/3]

void Aws::kendra::Model::QueryResult::SetQueryId ( const Aws::String value)
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 48 of file QueryResult.h.

◆ SetQueryId() [3/3]

void Aws::kendra::Model::QueryResult::SetQueryId ( const char *  value)
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 60 of file QueryResult.h.

◆ SetResultItems() [1/2]

void Aws::kendra::Model::QueryResult::SetResultItems ( Aws::Vector< QueryResultItem > &&  value)
inline

The results of the search.

Definition at line 94 of file QueryResult.h.

◆ SetResultItems() [2/2]

void Aws::kendra::Model::QueryResult::SetResultItems ( const Aws::Vector< QueryResultItem > &  value)
inline

The results of the search.

Definition at line 89 of file QueryResult.h.

◆ SetTotalNumberOfResults()

void Aws::kendra::Model::QueryResult::SetTotalNumberOfResults ( int  value)
inline

The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Definition at line 179 of file QueryResult.h.

◆ WithFacetResults() [1/2]

QueryResult& Aws::kendra::Model::QueryResult::WithFacetResults ( Aws::Vector< FacetResult > &&  value)
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 150 of file QueryResult.h.

◆ WithFacetResults() [2/2]

QueryResult& Aws::kendra::Model::QueryResult::WithFacetResults ( const Aws::Vector< FacetResult > &  value)
inline

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Definition at line 143 of file QueryResult.h.

◆ WithQueryId() [1/3]

QueryResult& Aws::kendra::Model::QueryResult::WithQueryId ( Aws::String &&  value)
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 72 of file QueryResult.h.

◆ WithQueryId() [2/3]

QueryResult& Aws::kendra::Model::QueryResult::WithQueryId ( const Aws::String value)
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 66 of file QueryResult.h.

◆ WithQueryId() [3/3]

QueryResult& Aws::kendra::Model::QueryResult::WithQueryId ( const char *  value)
inline

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Definition at line 78 of file QueryResult.h.

◆ WithResultItems() [1/2]

QueryResult& Aws::kendra::Model::QueryResult::WithResultItems ( Aws::Vector< QueryResultItem > &&  value)
inline

The results of the search.

Definition at line 104 of file QueryResult.h.

◆ WithResultItems() [2/2]

QueryResult& Aws::kendra::Model::QueryResult::WithResultItems ( const Aws::Vector< QueryResultItem > &  value)
inline

The results of the search.

Definition at line 99 of file QueryResult.h.

◆ WithTotalNumberOfResults()

QueryResult& Aws::kendra::Model::QueryResult::WithTotalNumberOfResults ( int  value)
inline

The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Definition at line 186 of file QueryResult.h.


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