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

#include <DescribeIndexFieldsRequest.h>

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

Public Member Functions

 DescribeIndexFieldsRequest ()
 
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)
 
DescribeIndexFieldsRequestWithDomainName (const Aws::String &value)
 
DescribeIndexFieldsRequestWithDomainName (Aws::String &&value)
 
DescribeIndexFieldsRequestWithDomainName (const char *value)
 
const Aws::Vector< Aws::String > & GetFieldNames () const
 
bool FieldNamesHasBeenSet () const
 
void SetFieldNames (const Aws::Vector< Aws::String > &value)
 
void SetFieldNames (Aws::Vector< Aws::String > &&value)
 
DescribeIndexFieldsRequestWithFieldNames (const Aws::Vector< Aws::String > &value)
 
DescribeIndexFieldsRequestWithFieldNames (Aws::Vector< Aws::String > &&value)
 
DescribeIndexFieldsRequestAddFieldNames (const Aws::String &value)
 
DescribeIndexFieldsRequestAddFieldNames (Aws::String &&value)
 
DescribeIndexFieldsRequestAddFieldNames (const char *value)
 
bool GetDeployed () const
 
bool DeployedHasBeenSet () const
 
void SetDeployed (bool value)
 
DescribeIndexFieldsRequestWithDeployed (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 DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields 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 DescribeIndexFieldsRequest.h.

Constructor & Destructor Documentation

◆ DescribeIndexFieldsRequest()

Aws::CloudSearch::Model::DescribeIndexFieldsRequest::DescribeIndexFieldsRequest ( )

Member Function Documentation

◆ AddFieldNames() [1/3]

DescribeIndexFieldsRequest& Aws::CloudSearch::Model::DescribeIndexFieldsRequest::AddFieldNames ( const Aws::String value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 129 of file DescribeIndexFieldsRequest.h.

◆ AddFieldNames() [2/3]

DescribeIndexFieldsRequest& Aws::CloudSearch::Model::DescribeIndexFieldsRequest::AddFieldNames ( Aws::String &&  value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 135 of file DescribeIndexFieldsRequest.h.

◆ AddFieldNames() [3/3]

DescribeIndexFieldsRequest& Aws::CloudSearch::Model::DescribeIndexFieldsRequest::AddFieldNames ( const char *  value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 141 of file DescribeIndexFieldsRequest.h.

◆ DeployedHasBeenSet()

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

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

Definition at line 154 of file DescribeIndexFieldsRequest.h.

◆ DomainNameHasBeenSet()

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

The name of the domain you want to describe.

Definition at line 56 of file DescribeIndexFieldsRequest.h.

◆ DumpBodyToUrl()

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

◆ FieldNamesHasBeenSet()

bool Aws::CloudSearch::Model::DescribeIndexFieldsRequest::FieldNamesHasBeenSet ( ) const
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 99 of file DescribeIndexFieldsRequest.h.

◆ GetDeployed()

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

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

Definition at line 148 of file DescribeIndexFieldsRequest.h.

◆ GetDomainName()

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

The name of the domain you want to describe.

Definition at line 51 of file DescribeIndexFieldsRequest.h.

◆ GetFieldNames()

const Aws::Vector<Aws::String>& Aws::CloudSearch::Model::DescribeIndexFieldsRequest::GetFieldNames ( ) const
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 93 of file DescribeIndexFieldsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file DescribeIndexFieldsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeployed()

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

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

Definition at line 160 of file DescribeIndexFieldsRequest.h.

◆ SetDomainName() [1/3]

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

The name of the domain you want to describe.

Definition at line 61 of file DescribeIndexFieldsRequest.h.

◆ SetDomainName() [2/3]

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

The name of the domain you want to describe.

Definition at line 66 of file DescribeIndexFieldsRequest.h.

◆ SetDomainName() [3/3]

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

The name of the domain you want to describe.

Definition at line 71 of file DescribeIndexFieldsRequest.h.

◆ SetFieldNames() [1/2]

void Aws::CloudSearch::Model::DescribeIndexFieldsRequest::SetFieldNames ( const Aws::Vector< Aws::String > &  value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 105 of file DescribeIndexFieldsRequest.h.

◆ SetFieldNames() [2/2]

void Aws::CloudSearch::Model::DescribeIndexFieldsRequest::SetFieldNames ( Aws::Vector< Aws::String > &&  value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 111 of file DescribeIndexFieldsRequest.h.

◆ WithDeployed()

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

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

Definition at line 166 of file DescribeIndexFieldsRequest.h.

◆ WithDomainName() [1/3]

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

The name of the domain you want to describe.

Definition at line 76 of file DescribeIndexFieldsRequest.h.

◆ WithDomainName() [2/3]

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

The name of the domain you want to describe.

Definition at line 81 of file DescribeIndexFieldsRequest.h.

◆ WithDomainName() [3/3]

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

The name of the domain you want to describe.

Definition at line 86 of file DescribeIndexFieldsRequest.h.

◆ WithFieldNames() [1/2]

DescribeIndexFieldsRequest& Aws::CloudSearch::Model::DescribeIndexFieldsRequest::WithFieldNames ( const Aws::Vector< Aws::String > &  value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 117 of file DescribeIndexFieldsRequest.h.

◆ WithFieldNames() [2/2]

DescribeIndexFieldsRequest& Aws::CloudSearch::Model::DescribeIndexFieldsRequest::WithFieldNames ( Aws::Vector< Aws::String > &&  value)
inline

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Definition at line 123 of file DescribeIndexFieldsRequest.h.


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