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

#include <GetQuerySuggestionsRequest.h>

+ Inheritance diagram for Aws::kendra::Model::GetQuerySuggestionsRequest:

Public Member Functions

 GetQuerySuggestionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIndexId () const
 
bool IndexIdHasBeenSet () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
GetQuerySuggestionsRequestWithIndexId (const Aws::String &value)
 
GetQuerySuggestionsRequestWithIndexId (Aws::String &&value)
 
GetQuerySuggestionsRequestWithIndexId (const char *value)
 
const Aws::StringGetQueryText () const
 
bool QueryTextHasBeenSet () const
 
void SetQueryText (const Aws::String &value)
 
void SetQueryText (Aws::String &&value)
 
void SetQueryText (const char *value)
 
GetQuerySuggestionsRequestWithQueryText (const Aws::String &value)
 
GetQuerySuggestionsRequestWithQueryText (Aws::String &&value)
 
GetQuerySuggestionsRequestWithQueryText (const char *value)
 
int GetMaxSuggestionsCount () const
 
bool MaxSuggestionsCountHasBeenSet () const
 
void SetMaxSuggestionsCount (int value)
 
GetQuerySuggestionsRequestWithMaxSuggestionsCount (int value)
 
- Public Member Functions inherited from Aws::kendra::KendraRequest
virtual ~KendraRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file GetQuerySuggestionsRequest.h.

Constructor & Destructor Documentation

◆ GetQuerySuggestionsRequest()

Aws::kendra::Model::GetQuerySuggestionsRequest::GetQuerySuggestionsRequest ( )

Member Function Documentation

◆ GetIndexId()

const Aws::String& Aws::kendra::Model::GetQuerySuggestionsRequest::GetIndexId ( ) const
inline

The identifier of the index you want to get query suggestions from.

Definition at line 40 of file GetQuerySuggestionsRequest.h.

◆ GetMaxSuggestionsCount()

int Aws::kendra::Model::GetQuerySuggestionsRequest::GetMaxSuggestionsCount ( ) const
inline

The maximum number of query suggestions you want to show to your users.

Definition at line 162 of file GetQuerySuggestionsRequest.h.

◆ GetQueryText()

const Aws::String& Aws::kendra::Model::GetQuerySuggestionsRequest::GetQueryText ( ) const
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 86 of file GetQuerySuggestionsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::GetQuerySuggestionsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::GetQuerySuggestionsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetQuerySuggestionsRequest.h.

◆ IndexIdHasBeenSet()

bool Aws::kendra::Model::GetQuerySuggestionsRequest::IndexIdHasBeenSet ( ) const
inline

The identifier of the index you want to get query suggestions from.

Definition at line 45 of file GetQuerySuggestionsRequest.h.

◆ MaxSuggestionsCountHasBeenSet()

bool Aws::kendra::Model::GetQuerySuggestionsRequest::MaxSuggestionsCountHasBeenSet ( ) const
inline

The maximum number of query suggestions you want to show to your users.

Definition at line 167 of file GetQuerySuggestionsRequest.h.

◆ QueryTextHasBeenSet()

bool Aws::kendra::Model::GetQuerySuggestionsRequest::QueryTextHasBeenSet ( ) const
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 96 of file GetQuerySuggestionsRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::GetQuerySuggestionsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIndexId() [1/3]

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetIndexId ( Aws::String &&  value)
inline

The identifier of the index you want to get query suggestions from.

Definition at line 55 of file GetQuerySuggestionsRequest.h.

◆ SetIndexId() [2/3]

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetIndexId ( const Aws::String value)
inline

The identifier of the index you want to get query suggestions from.

Definition at line 50 of file GetQuerySuggestionsRequest.h.

◆ SetIndexId() [3/3]

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetIndexId ( const char *  value)
inline

The identifier of the index you want to get query suggestions from.

Definition at line 60 of file GetQuerySuggestionsRequest.h.

◆ SetMaxSuggestionsCount()

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetMaxSuggestionsCount ( int  value)
inline

The maximum number of query suggestions you want to show to your users.

Definition at line 172 of file GetQuerySuggestionsRequest.h.

◆ SetQueryText() [1/3]

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetQueryText ( Aws::String &&  value)
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 116 of file GetQuerySuggestionsRequest.h.

◆ SetQueryText() [2/3]

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetQueryText ( const Aws::String value)
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 106 of file GetQuerySuggestionsRequest.h.

◆ SetQueryText() [3/3]

void Aws::kendra::Model::GetQuerySuggestionsRequest::SetQueryText ( const char *  value)
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 126 of file GetQuerySuggestionsRequest.h.

◆ WithIndexId() [1/3]

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithIndexId ( Aws::String &&  value)
inline

The identifier of the index you want to get query suggestions from.

Definition at line 70 of file GetQuerySuggestionsRequest.h.

◆ WithIndexId() [2/3]

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithIndexId ( const Aws::String value)
inline

The identifier of the index you want to get query suggestions from.

Definition at line 65 of file GetQuerySuggestionsRequest.h.

◆ WithIndexId() [3/3]

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithIndexId ( const char *  value)
inline

The identifier of the index you want to get query suggestions from.

Definition at line 75 of file GetQuerySuggestionsRequest.h.

◆ WithMaxSuggestionsCount()

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithMaxSuggestionsCount ( int  value)
inline

The maximum number of query suggestions you want to show to your users.

Definition at line 177 of file GetQuerySuggestionsRequest.h.

◆ WithQueryText() [1/3]

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithQueryText ( Aws::String &&  value)
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 146 of file GetQuerySuggestionsRequest.h.

◆ WithQueryText() [2/3]

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithQueryText ( const Aws::String value)
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 136 of file GetQuerySuggestionsRequest.h.

◆ WithQueryText() [3/3]

GetQuerySuggestionsRequest& Aws::kendra::Model::GetQuerySuggestionsRequest::WithQueryText ( const char *  value)
inline

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Definition at line 156 of file GetQuerySuggestionsRequest.h.


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