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

#include <ListGroupsRequest.h>

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

Public Member Functions

 ListGroupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::Vector< GroupFilter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< GroupFilter > &value)
 
void SetFilters (Aws::Vector< GroupFilter > &&value)
 
ListGroupsRequestWithFilters (const Aws::Vector< GroupFilter > &value)
 
ListGroupsRequestWithFilters (Aws::Vector< GroupFilter > &&value)
 
ListGroupsRequestAddFilters (const GroupFilter &value)
 
ListGroupsRequestAddFilters (GroupFilter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListGroupsRequestWithMaxResults (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)
 
ListGroupsRequestWithNextToken (const Aws::String &value)
 
ListGroupsRequestWithNextToken (Aws::String &&value)
 
ListGroupsRequestWithNextToken (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 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 27 of file ListGroupsRequest.h.

Constructor & Destructor Documentation

◆ ListGroupsRequest()

Aws::ResourceGroups::Model::ListGroupsRequest::ListGroupsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::AddFilters ( const GroupFilter value)
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 139 of file ListGroupsRequest.h.

◆ AddFilters() [2/2]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::AddFilters ( GroupFilter &&  value)
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 153 of file ListGroupsRequest.h.

◆ AddQueryStringParameters()

void Aws::ResourceGroups::Model::ListGroupsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupsRequest::FiltersHasBeenSet ( ) const
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 69 of file ListGroupsRequest.h.

◆ GetFilters()

const Aws::Vector<GroupFilter>& Aws::ResourceGroups::Model::ListGroupsRequest::GetFilters ( ) const
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 55 of file ListGroupsRequest.h.

◆ GetMaxResults()

int Aws::ResourceGroups::Model::ListGroupsRequest::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 167 of file ListGroupsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ResourceGroups::Model::ListGroupsRequest::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 216 of file ListGroupsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListGroupsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupsRequest::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 180 of file ListGroupsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ResourceGroups::Model::ListGroupsRequest::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 225 of file ListGroupsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::ResourceGroups::Model::ListGroupsRequest::SetFilters ( const Aws::Vector< GroupFilter > &  value)
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 83 of file ListGroupsRequest.h.

◆ SetFilters() [2/2]

void Aws::ResourceGroups::Model::ListGroupsRequest::SetFilters ( Aws::Vector< GroupFilter > &&  value)
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 97 of file ListGroupsRequest.h.

◆ SetMaxResults()

void Aws::ResourceGroups::Model::ListGroupsRequest::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 193 of file ListGroupsRequest.h.

◆ SetNextToken() [1/3]

void Aws::ResourceGroups::Model::ListGroupsRequest::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 234 of file ListGroupsRequest.h.

◆ SetNextToken() [2/3]

void Aws::ResourceGroups::Model::ListGroupsRequest::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 243 of file ListGroupsRequest.h.

◆ SetNextToken() [3/3]

void Aws::ResourceGroups::Model::ListGroupsRequest::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 252 of file ListGroupsRequest.h.

◆ WithFilters() [1/2]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::WithFilters ( const Aws::Vector< GroupFilter > &  value)
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 111 of file ListGroupsRequest.h.

◆ WithFilters() [2/2]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::WithFilters ( Aws::Vector< GroupFilter > &&  value)
inline

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

  • resource-type

    • Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

  • configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

    • AWS:EC2::CapacityReservationPool

Definition at line 125 of file ListGroupsRequest.h.

◆ WithMaxResults()

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::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 206 of file ListGroupsRequest.h.

◆ WithNextToken() [1/3]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::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 261 of file ListGroupsRequest.h.

◆ WithNextToken() [2/3]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::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 270 of file ListGroupsRequest.h.

◆ WithNextToken() [3/3]

ListGroupsRequest& Aws::ResourceGroups::Model::ListGroupsRequest::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 279 of file ListGroupsRequest.h.


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