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

#include <DescribeAnalysisSchemesRequest.h>

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

Public Member Functions

 DescribeAnalysisSchemesRequest ()
 
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)
 
DescribeAnalysisSchemesRequestWithDomainName (const Aws::String &value)
 
DescribeAnalysisSchemesRequestWithDomainName (Aws::String &&value)
 
DescribeAnalysisSchemesRequestWithDomainName (const char *value)
 
const Aws::Vector< Aws::String > & GetAnalysisSchemeNames () const
 
bool AnalysisSchemeNamesHasBeenSet () const
 
void SetAnalysisSchemeNames (const Aws::Vector< Aws::String > &value)
 
void SetAnalysisSchemeNames (Aws::Vector< Aws::String > &&value)
 
DescribeAnalysisSchemesRequestWithAnalysisSchemeNames (const Aws::Vector< Aws::String > &value)
 
DescribeAnalysisSchemesRequestWithAnalysisSchemeNames (Aws::Vector< Aws::String > &&value)
 
DescribeAnalysisSchemesRequestAddAnalysisSchemeNames (const Aws::String &value)
 
DescribeAnalysisSchemesRequestAddAnalysisSchemeNames (Aws::String &&value)
 
DescribeAnalysisSchemesRequestAddAnalysisSchemeNames (const char *value)
 
bool GetDeployed () const
 
bool DeployedHasBeenSet () const
 
void SetDeployed (bool value)
 
DescribeAnalysisSchemesRequestWithDeployed (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 DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes 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 31 of file DescribeAnalysisSchemesRequest.h.

Constructor & Destructor Documentation

◆ DescribeAnalysisSchemesRequest()

Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::DescribeAnalysisSchemesRequest ( )

Member Function Documentation

◆ AddAnalysisSchemeNames() [1/3]

DescribeAnalysisSchemesRequest& Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::AddAnalysisSchemeNames ( const Aws::String value)
inline

The analysis schemes you want to describe.

Definition at line 123 of file DescribeAnalysisSchemesRequest.h.

◆ AddAnalysisSchemeNames() [2/3]

DescribeAnalysisSchemesRequest& Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::AddAnalysisSchemeNames ( Aws::String &&  value)
inline

The analysis schemes you want to describe.

Definition at line 128 of file DescribeAnalysisSchemesRequest.h.

◆ AddAnalysisSchemeNames() [3/3]

DescribeAnalysisSchemesRequest& Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::AddAnalysisSchemeNames ( const char *  value)
inline

The analysis schemes you want to describe.

Definition at line 133 of file DescribeAnalysisSchemesRequest.h.

◆ AnalysisSchemeNamesHasBeenSet()

bool Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::AnalysisSchemeNamesHasBeenSet ( ) const
inline

The analysis schemes you want to describe.

Definition at line 98 of file DescribeAnalysisSchemesRequest.h.

◆ DeployedHasBeenSet()

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

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

Definition at line 146 of file DescribeAnalysisSchemesRequest.h.

◆ DomainNameHasBeenSet()

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

The name of the domain you want to describe.

Definition at line 57 of file DescribeAnalysisSchemesRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::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.

◆ GetAnalysisSchemeNames()

const Aws::Vector<Aws::String>& Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::GetAnalysisSchemeNames ( ) const
inline

The analysis schemes you want to describe.

Definition at line 93 of file DescribeAnalysisSchemesRequest.h.

◆ GetDeployed()

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

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

Definition at line 140 of file DescribeAnalysisSchemesRequest.h.

◆ GetDomainName()

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

The name of the domain you want to describe.

Definition at line 52 of file DescribeAnalysisSchemesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file DescribeAnalysisSchemesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAnalysisSchemeNames() [1/2]

void Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::SetAnalysisSchemeNames ( const Aws::Vector< Aws::String > &  value)
inline

The analysis schemes you want to describe.

Definition at line 103 of file DescribeAnalysisSchemesRequest.h.

◆ SetAnalysisSchemeNames() [2/2]

void Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::SetAnalysisSchemeNames ( Aws::Vector< Aws::String > &&  value)
inline

The analysis schemes you want to describe.

Definition at line 108 of file DescribeAnalysisSchemesRequest.h.

◆ SetDeployed()

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

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

Definition at line 152 of file DescribeAnalysisSchemesRequest.h.

◆ SetDomainName() [1/3]

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

The name of the domain you want to describe.

Definition at line 62 of file DescribeAnalysisSchemesRequest.h.

◆ SetDomainName() [2/3]

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

The name of the domain you want to describe.

Definition at line 67 of file DescribeAnalysisSchemesRequest.h.

◆ SetDomainName() [3/3]

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

The name of the domain you want to describe.

Definition at line 72 of file DescribeAnalysisSchemesRequest.h.

◆ WithAnalysisSchemeNames() [1/2]

DescribeAnalysisSchemesRequest& Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::WithAnalysisSchemeNames ( const Aws::Vector< Aws::String > &  value)
inline

The analysis schemes you want to describe.

Definition at line 113 of file DescribeAnalysisSchemesRequest.h.

◆ WithAnalysisSchemeNames() [2/2]

DescribeAnalysisSchemesRequest& Aws::CloudSearch::Model::DescribeAnalysisSchemesRequest::WithAnalysisSchemeNames ( Aws::Vector< Aws::String > &&  value)
inline

The analysis schemes you want to describe.

Definition at line 118 of file DescribeAnalysisSchemesRequest.h.

◆ WithDeployed()

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

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

Definition at line 158 of file DescribeAnalysisSchemesRequest.h.

◆ WithDomainName() [1/3]

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

The name of the domain you want to describe.

Definition at line 77 of file DescribeAnalysisSchemesRequest.h.

◆ WithDomainName() [2/3]

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

The name of the domain you want to describe.

Definition at line 82 of file DescribeAnalysisSchemesRequest.h.

◆ WithDomainName() [3/3]

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

The name of the domain you want to describe.

Definition at line 87 of file DescribeAnalysisSchemesRequest.h.


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