AWS SDK for C++  1.9.45
AWS SDK for C++
Public Member Functions | List of all members
Aws::ResourceGroups::Model::SearchResourcesRequest Class Reference

#include <SearchResourcesRequest.h>

+ Inheritance diagram for Aws::ResourceGroups::Model::SearchResourcesRequest:

Public Member Functions

 SearchResourcesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const ResourceQueryGetResourceQuery () const
 
bool ResourceQueryHasBeenSet () const
 
void SetResourceQuery (const ResourceQuery &value)
 
void SetResourceQuery (ResourceQuery &&value)
 
SearchResourcesRequestWithResourceQuery (const ResourceQuery &value)
 
SearchResourcesRequestWithResourceQuery (ResourceQuery &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
SearchResourcesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
SearchResourcesRequestWithNextToken (const Aws::String &value)
 
SearchResourcesRequestWithNextToken (Aws::String &&value)
 
SearchResourcesRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::ResourceGroups::ResourceGroupsRequest
virtual ~ResourceGroupsRequest ()
 
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::ResourceGroups::ResourceGroupsRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file SearchResourcesRequest.h.

Constructor & Destructor Documentation

◆ SearchResourcesRequest()

Aws::ResourceGroups::Model::SearchResourcesRequest::SearchResourcesRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::ResourceGroups::Model::SearchResourcesRequest::GetMaxResults ( ) const
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 84 of file SearchResourcesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ResourceGroups::Model::SearchResourcesRequest::GetNextToken ( ) const
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 133 of file SearchResourcesRequest.h.

◆ GetResourceQuery()

const ResourceQuery& Aws::ResourceGroups::Model::SearchResourcesRequest::GetResourceQuery ( ) const
inline

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Definition at line 40 of file SearchResourcesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ResourceGroups::Model::SearchResourcesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file SearchResourcesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::ResourceGroups::Model::SearchResourcesRequest::MaxResultsHasBeenSet ( ) const
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 97 of file SearchResourcesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ResourceGroups::Model::SearchResourcesRequest::NextTokenHasBeenSet ( ) const
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 142 of file SearchResourcesRequest.h.

◆ ResourceQueryHasBeenSet()

bool Aws::ResourceGroups::Model::SearchResourcesRequest::ResourceQueryHasBeenSet ( ) const
inline

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Definition at line 46 of file SearchResourcesRequest.h.

◆ SerializePayload()

Aws::String Aws::ResourceGroups::Model::SearchResourcesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::ResourceGroups::Model::SearchResourcesRequest::SetMaxResults ( int  value)
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 110 of file SearchResourcesRequest.h.

◆ SetNextToken() [1/3]

void Aws::ResourceGroups::Model::SearchResourcesRequest::SetNextToken ( Aws::String &&  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 160 of file SearchResourcesRequest.h.

◆ SetNextToken() [2/3]

void Aws::ResourceGroups::Model::SearchResourcesRequest::SetNextToken ( const Aws::String value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 151 of file SearchResourcesRequest.h.

◆ SetNextToken() [3/3]

void Aws::ResourceGroups::Model::SearchResourcesRequest::SetNextToken ( const char *  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 169 of file SearchResourcesRequest.h.

◆ SetResourceQuery() [1/2]

void Aws::ResourceGroups::Model::SearchResourcesRequest::SetResourceQuery ( const ResourceQuery value)
inline

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Definition at line 52 of file SearchResourcesRequest.h.

◆ SetResourceQuery() [2/2]

void Aws::ResourceGroups::Model::SearchResourcesRequest::SetResourceQuery ( ResourceQuery &&  value)
inline

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Definition at line 58 of file SearchResourcesRequest.h.

◆ WithMaxResults()

SearchResourcesRequest& Aws::ResourceGroups::Model::SearchResourcesRequest::WithMaxResults ( int  value)
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 123 of file SearchResourcesRequest.h.

◆ WithNextToken() [1/3]

SearchResourcesRequest& Aws::ResourceGroups::Model::SearchResourcesRequest::WithNextToken ( Aws::String &&  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 187 of file SearchResourcesRequest.h.

◆ WithNextToken() [2/3]

SearchResourcesRequest& Aws::ResourceGroups::Model::SearchResourcesRequest::WithNextToken ( const Aws::String value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 178 of file SearchResourcesRequest.h.

◆ WithNextToken() [3/3]

SearchResourcesRequest& Aws::ResourceGroups::Model::SearchResourcesRequest::WithNextToken ( const char *  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Definition at line 196 of file SearchResourcesRequest.h.

◆ WithResourceQuery() [1/2]

SearchResourcesRequest& Aws::ResourceGroups::Model::SearchResourcesRequest::WithResourceQuery ( const ResourceQuery value)
inline

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Definition at line 64 of file SearchResourcesRequest.h.

◆ WithResourceQuery() [2/2]

SearchResourcesRequest& Aws::ResourceGroups::Model::SearchResourcesRequest::WithResourceQuery ( ResourceQuery &&  value)
inline

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

Definition at line 70 of file SearchResourcesRequest.h.


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