AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudSearch::Model::DescribeSuggestersRequest Class Reference

#include <DescribeSuggestersRequest.h>

+ Inheritance diagram for Aws::CloudSearch::Model::DescribeSuggestersRequest:

Public Member Functions

 DescribeSuggestersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDomainName () const
 
bool DomainNameHasBeenSet () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
DescribeSuggestersRequestWithDomainName (const Aws::String &value)
 
DescribeSuggestersRequestWithDomainName (Aws::String &&value)
 
DescribeSuggestersRequestWithDomainName (const char *value)
 
const Aws::Vector< Aws::String > & GetSuggesterNames () const
 
bool SuggesterNamesHasBeenSet () const
 
void SetSuggesterNames (const Aws::Vector< Aws::String > &value)
 
void SetSuggesterNames (Aws::Vector< Aws::String > &&value)
 
DescribeSuggestersRequestWithSuggesterNames (const Aws::Vector< Aws::String > &value)
 
DescribeSuggestersRequestWithSuggesterNames (Aws::Vector< Aws::String > &&value)
 
DescribeSuggestersRequestAddSuggesterNames (const Aws::String &value)
 
DescribeSuggestersRequestAddSuggesterNames (Aws::String &&value)
 
DescribeSuggestersRequestAddSuggesterNames (const char *value)
 
bool GetDeployed () const
 
bool DeployedHasBeenSet () const
 
void SetDeployed (bool value)
 
DescribeSuggestersRequestWithDeployed (bool value)
 
- Public Member Functions inherited from Aws::CloudSearch::CloudSearchRequest
virtual ~CloudSearchRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudSearch::CloudSearchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See Also:

AWS API Reference

Definition at line 30 of file DescribeSuggestersRequest.h.

Constructor & Destructor Documentation

◆ DescribeSuggestersRequest()

Aws::CloudSearch::Model::DescribeSuggestersRequest::DescribeSuggestersRequest ( )

Member Function Documentation

◆ AddSuggesterNames() [1/3]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::AddSuggesterNames ( const Aws::String value)
inline

The suggesters you want to describe.

Definition at line 122 of file DescribeSuggestersRequest.h.

◆ AddSuggesterNames() [2/3]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::AddSuggesterNames ( Aws::String &&  value)
inline

The suggesters you want to describe.

Definition at line 127 of file DescribeSuggestersRequest.h.

◆ AddSuggesterNames() [3/3]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::AddSuggesterNames ( const char *  value)
inline

The suggesters you want to describe.

Definition at line 132 of file DescribeSuggestersRequest.h.

◆ DeployedHasBeenSet()

bool Aws::CloudSearch::Model::DescribeSuggestersRequest::DeployedHasBeenSet ( ) const
inline

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Definition at line 145 of file DescribeSuggestersRequest.h.

◆ DomainNameHasBeenSet()

bool Aws::CloudSearch::Model::DescribeSuggestersRequest::DomainNameHasBeenSet ( ) const
inline

The name of the domain you want to describe.

Definition at line 56 of file DescribeSuggestersRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudSearch::Model::DescribeSuggestersRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetDeployed()

bool Aws::CloudSearch::Model::DescribeSuggestersRequest::GetDeployed ( ) const
inline

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Definition at line 139 of file DescribeSuggestersRequest.h.

◆ GetDomainName()

const Aws::String& Aws::CloudSearch::Model::DescribeSuggestersRequest::GetDomainName ( ) const
inline

The name of the domain you want to describe.

Definition at line 51 of file DescribeSuggestersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudSearch::Model::DescribeSuggestersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file DescribeSuggestersRequest.h.

◆ GetSuggesterNames()

const Aws::Vector<Aws::String>& Aws::CloudSearch::Model::DescribeSuggestersRequest::GetSuggesterNames ( ) const
inline

The suggesters you want to describe.

Definition at line 92 of file DescribeSuggestersRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudSearch::Model::DescribeSuggestersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeployed()

void Aws::CloudSearch::Model::DescribeSuggestersRequest::SetDeployed ( bool  value)
inline

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Definition at line 151 of file DescribeSuggestersRequest.h.

◆ SetDomainName() [1/3]

void Aws::CloudSearch::Model::DescribeSuggestersRequest::SetDomainName ( const Aws::String value)
inline

The name of the domain you want to describe.

Definition at line 61 of file DescribeSuggestersRequest.h.

◆ SetDomainName() [2/3]

void Aws::CloudSearch::Model::DescribeSuggestersRequest::SetDomainName ( Aws::String &&  value)
inline

The name of the domain you want to describe.

Definition at line 66 of file DescribeSuggestersRequest.h.

◆ SetDomainName() [3/3]

void Aws::CloudSearch::Model::DescribeSuggestersRequest::SetDomainName ( const char *  value)
inline

The name of the domain you want to describe.

Definition at line 71 of file DescribeSuggestersRequest.h.

◆ SetSuggesterNames() [1/2]

void Aws::CloudSearch::Model::DescribeSuggestersRequest::SetSuggesterNames ( const Aws::Vector< Aws::String > &  value)
inline

The suggesters you want to describe.

Definition at line 102 of file DescribeSuggestersRequest.h.

◆ SetSuggesterNames() [2/2]

void Aws::CloudSearch::Model::DescribeSuggestersRequest::SetSuggesterNames ( Aws::Vector< Aws::String > &&  value)
inline

The suggesters you want to describe.

Definition at line 107 of file DescribeSuggestersRequest.h.

◆ SuggesterNamesHasBeenSet()

bool Aws::CloudSearch::Model::DescribeSuggestersRequest::SuggesterNamesHasBeenSet ( ) const
inline

The suggesters you want to describe.

Definition at line 97 of file DescribeSuggestersRequest.h.

◆ WithDeployed()

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::WithDeployed ( bool  value)
inline

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Definition at line 157 of file DescribeSuggestersRequest.h.

◆ WithDomainName() [1/3]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::WithDomainName ( const Aws::String value)
inline

The name of the domain you want to describe.

Definition at line 76 of file DescribeSuggestersRequest.h.

◆ WithDomainName() [2/3]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::WithDomainName ( Aws::String &&  value)
inline

The name of the domain you want to describe.

Definition at line 81 of file DescribeSuggestersRequest.h.

◆ WithDomainName() [3/3]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::WithDomainName ( const char *  value)
inline

The name of the domain you want to describe.

Definition at line 86 of file DescribeSuggestersRequest.h.

◆ WithSuggesterNames() [1/2]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::WithSuggesterNames ( const Aws::Vector< Aws::String > &  value)
inline

The suggesters you want to describe.

Definition at line 112 of file DescribeSuggestersRequest.h.

◆ WithSuggesterNames() [2/2]

DescribeSuggestersRequest& Aws::CloudSearch::Model::DescribeSuggestersRequest::WithSuggesterNames ( Aws::Vector< Aws::String > &&  value)
inline

The suggesters you want to describe.

Definition at line 117 of file DescribeSuggestersRequest.h.


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