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

#include <ListGroupsRequest.h>

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

Public Member Functions

 ListGroupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIdentityStoreId () const
 
bool IdentityStoreIdHasBeenSet () const
 
void SetIdentityStoreId (const Aws::String &value)
 
void SetIdentityStoreId (Aws::String &&value)
 
void SetIdentityStoreId (const char *value)
 
ListGroupsRequestWithIdentityStoreId (const Aws::String &value)
 
ListGroupsRequestWithIdentityStoreId (Aws::String &&value)
 
ListGroupsRequestWithIdentityStoreId (const char *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)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListGroupsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListGroupsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListGroupsRequestAddFilters (const Filter &value)
 
ListGroupsRequestAddFilters (Filter &&value)
 
- Public Member Functions inherited from Aws::IdentityStore::IdentityStoreRequest
virtual ~IdentityStoreRequest ()
 
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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file ListGroupsRequest.h.

Constructor & Destructor Documentation

◆ ListGroupsRequest()

Aws::IdentityStore::Model::ListGroupsRequest::ListGroupsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::AddFilters ( const Filter value)
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 246 of file ListGroupsRequest.h.

◆ AddFilters() [2/2]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::AddFilters ( Filter &&  value)
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 252 of file ListGroupsRequest.h.

◆ FiltersHasBeenSet()

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

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 216 of file ListGroupsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::IdentityStore::Model::ListGroupsRequest::GetFilters ( ) const
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 210 of file ListGroupsRequest.h.

◆ GetIdentityStoreId()

const Aws::String& Aws::IdentityStore::Model::ListGroupsRequest::GetIdentityStoreId ( ) const
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 45 of file ListGroupsRequest.h.

◆ GetMaxResults()

int Aws::IdentityStore::Model::ListGroupsRequest::GetMaxResults ( ) const
inline

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Definition at line 109 of file ListGroupsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::IdentityStore::Model::ListGroupsRequest::GetNextToken ( ) const
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 140 of file ListGroupsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::IdentityStore::Model::ListGroupsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListGroupsRequest.h.

◆ IdentityStoreIdHasBeenSet()

bool Aws::IdentityStore::Model::ListGroupsRequest::IdentityStoreIdHasBeenSet ( ) const
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 53 of file ListGroupsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::IdentityStore::Model::ListGroupsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Definition at line 116 of file ListGroupsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::IdentityStore::Model::ListGroupsRequest::NextTokenHasBeenSet ( ) const
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 149 of file ListGroupsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::IdentityStore::Model::ListGroupsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 228 of file ListGroupsRequest.h.

◆ SetFilters() [2/2]

void Aws::IdentityStore::Model::ListGroupsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 222 of file ListGroupsRequest.h.

◆ SetIdentityStoreId() [1/3]

void Aws::IdentityStore::Model::ListGroupsRequest::SetIdentityStoreId ( Aws::String &&  value)
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 69 of file ListGroupsRequest.h.

◆ SetIdentityStoreId() [2/3]

void Aws::IdentityStore::Model::ListGroupsRequest::SetIdentityStoreId ( const Aws::String value)
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 61 of file ListGroupsRequest.h.

◆ SetIdentityStoreId() [3/3]

void Aws::IdentityStore::Model::ListGroupsRequest::SetIdentityStoreId ( const char *  value)
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 77 of file ListGroupsRequest.h.

◆ SetMaxResults()

void Aws::IdentityStore::Model::ListGroupsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Definition at line 123 of file ListGroupsRequest.h.

◆ SetNextToken() [1/3]

void Aws::IdentityStore::Model::ListGroupsRequest::SetNextToken ( Aws::String &&  value)
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 167 of file ListGroupsRequest.h.

◆ SetNextToken() [2/3]

void Aws::IdentityStore::Model::ListGroupsRequest::SetNextToken ( const Aws::String value)
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 158 of file ListGroupsRequest.h.

◆ SetNextToken() [3/3]

void Aws::IdentityStore::Model::ListGroupsRequest::SetNextToken ( const char *  value)
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 176 of file ListGroupsRequest.h.

◆ WithFilters() [1/2]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 240 of file ListGroupsRequest.h.

◆ WithFilters() [2/2]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Definition at line 234 of file ListGroupsRequest.h.

◆ WithIdentityStoreId() [1/3]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithIdentityStoreId ( Aws::String &&  value)
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 93 of file ListGroupsRequest.h.

◆ WithIdentityStoreId() [2/3]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithIdentityStoreId ( const Aws::String value)
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 85 of file ListGroupsRequest.h.

◆ WithIdentityStoreId() [3/3]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithIdentityStoreId ( const char *  value)
inline

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Definition at line 101 of file ListGroupsRequest.h.

◆ WithMaxResults()

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Definition at line 130 of file ListGroupsRequest.h.

◆ WithNextToken() [1/3]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithNextToken ( Aws::String &&  value)
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 194 of file ListGroupsRequest.h.

◆ WithNextToken() [2/3]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithNextToken ( const Aws::String value)
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 185 of file ListGroupsRequest.h.

◆ WithNextToken() [3/3]

ListGroupsRequest& Aws::IdentityStore::Model::ListGroupsRequest::WithNextToken ( const char *  value)
inline

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Definition at line 203 of file ListGroupsRequest.h.


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