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

#include <DescribeGroupsRequest.h>

+ Inheritance diagram for Aws::WorkDocs::Model::DescribeGroupsRequest:

Public Member Functions

 DescribeGroupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAuthenticationToken () const
 
bool AuthenticationTokenHasBeenSet () const
 
void SetAuthenticationToken (const Aws::String &value)
 
void SetAuthenticationToken (Aws::String &&value)
 
void SetAuthenticationToken (const char *value)
 
DescribeGroupsRequestWithAuthenticationToken (const Aws::String &value)
 
DescribeGroupsRequestWithAuthenticationToken (Aws::String &&value)
 
DescribeGroupsRequestWithAuthenticationToken (const char *value)
 
const Aws::StringGetSearchQuery () const
 
bool SearchQueryHasBeenSet () const
 
void SetSearchQuery (const Aws::String &value)
 
void SetSearchQuery (Aws::String &&value)
 
void SetSearchQuery (const char *value)
 
DescribeGroupsRequestWithSearchQuery (const Aws::String &value)
 
DescribeGroupsRequestWithSearchQuery (Aws::String &&value)
 
DescribeGroupsRequestWithSearchQuery (const char *value)
 
const Aws::StringGetOrganizationId () const
 
bool OrganizationIdHasBeenSet () const
 
void SetOrganizationId (const Aws::String &value)
 
void SetOrganizationId (Aws::String &&value)
 
void SetOrganizationId (const char *value)
 
DescribeGroupsRequestWithOrganizationId (const Aws::String &value)
 
DescribeGroupsRequestWithOrganizationId (Aws::String &&value)
 
DescribeGroupsRequestWithOrganizationId (const char *value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeGroupsRequestWithMarker (const Aws::String &value)
 
DescribeGroupsRequestWithMarker (Aws::String &&value)
 
DescribeGroupsRequestWithMarker (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeGroupsRequestWithLimit (int value)
 
- Public Member Functions inherited from Aws::WorkDocs::WorkDocsRequest
virtual ~WorkDocsRequest ()
 
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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file DescribeGroupsRequest.h.

Constructor & Destructor Documentation

◆ DescribeGroupsRequest()

Aws::WorkDocs::Model::DescribeGroupsRequest::DescribeGroupsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::WorkDocs::Model::DescribeGroupsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AuthenticationTokenHasBeenSet()

bool Aws::WorkDocs::Model::DescribeGroupsRequest::AuthenticationTokenHasBeenSet ( ) const
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 53 of file DescribeGroupsRequest.h.

◆ GetAuthenticationToken()

const Aws::String& Aws::WorkDocs::Model::DescribeGroupsRequest::GetAuthenticationToken ( ) const
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 47 of file DescribeGroupsRequest.h.

◆ GetLimit()

int Aws::WorkDocs::Model::DescribeGroupsRequest::GetLimit ( ) const
inline

The maximum number of items to return with this call.

Definition at line 226 of file DescribeGroupsRequest.h.

◆ GetMarker()

const Aws::String& Aws::WorkDocs::Model::DescribeGroupsRequest::GetMarker ( ) const
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 178 of file DescribeGroupsRequest.h.

◆ GetOrganizationId()

const Aws::String& Aws::WorkDocs::Model::DescribeGroupsRequest::GetOrganizationId ( ) const
inline

The ID of the organization.

Definition at line 136 of file DescribeGroupsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WorkDocs::Model::DescribeGroupsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WorkDocs::WorkDocsRequest.

◆ GetSearchQuery()

const Aws::String& Aws::WorkDocs::Model::DescribeGroupsRequest::GetSearchQuery ( ) const
inline

A query to describe groups by group name.

Definition at line 95 of file DescribeGroupsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::WorkDocs::Model::DescribeGroupsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeGroupsRequest.h.

◆ LimitHasBeenSet()

bool Aws::WorkDocs::Model::DescribeGroupsRequest::LimitHasBeenSet ( ) const
inline

The maximum number of items to return with this call.

Definition at line 231 of file DescribeGroupsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::WorkDocs::Model::DescribeGroupsRequest::MarkerHasBeenSet ( ) const
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 184 of file DescribeGroupsRequest.h.

◆ OrganizationIdHasBeenSet()

bool Aws::WorkDocs::Model::DescribeGroupsRequest::OrganizationIdHasBeenSet ( ) const
inline

The ID of the organization.

Definition at line 141 of file DescribeGroupsRequest.h.

◆ SearchQueryHasBeenSet()

bool Aws::WorkDocs::Model::DescribeGroupsRequest::SearchQueryHasBeenSet ( ) const
inline

A query to describe groups by group name.

Definition at line 100 of file DescribeGroupsRequest.h.

◆ SerializePayload()

Aws::String Aws::WorkDocs::Model::DescribeGroupsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthenticationToken() [1/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetAuthenticationToken ( const Aws::String value)
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 59 of file DescribeGroupsRequest.h.

◆ SetAuthenticationToken() [2/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetAuthenticationToken ( Aws::String &&  value)
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 65 of file DescribeGroupsRequest.h.

◆ SetAuthenticationToken() [3/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetAuthenticationToken ( const char *  value)
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 71 of file DescribeGroupsRequest.h.

◆ SetLimit()

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetLimit ( int  value)
inline

The maximum number of items to return with this call.

Definition at line 236 of file DescribeGroupsRequest.h.

◆ SetMarker() [1/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetMarker ( const Aws::String value)
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 190 of file DescribeGroupsRequest.h.

◆ SetMarker() [2/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetMarker ( Aws::String &&  value)
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 196 of file DescribeGroupsRequest.h.

◆ SetMarker() [3/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetMarker ( const char *  value)
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 202 of file DescribeGroupsRequest.h.

◆ SetOrganizationId() [1/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetOrganizationId ( const Aws::String value)
inline

The ID of the organization.

Definition at line 146 of file DescribeGroupsRequest.h.

◆ SetOrganizationId() [2/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetOrganizationId ( Aws::String &&  value)
inline

The ID of the organization.

Definition at line 151 of file DescribeGroupsRequest.h.

◆ SetOrganizationId() [3/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetOrganizationId ( const char *  value)
inline

The ID of the organization.

Definition at line 156 of file DescribeGroupsRequest.h.

◆ SetSearchQuery() [1/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetSearchQuery ( const Aws::String value)
inline

A query to describe groups by group name.

Definition at line 105 of file DescribeGroupsRequest.h.

◆ SetSearchQuery() [2/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetSearchQuery ( Aws::String &&  value)
inline

A query to describe groups by group name.

Definition at line 110 of file DescribeGroupsRequest.h.

◆ SetSearchQuery() [3/3]

void Aws::WorkDocs::Model::DescribeGroupsRequest::SetSearchQuery ( const char *  value)
inline

A query to describe groups by group name.

Definition at line 115 of file DescribeGroupsRequest.h.

◆ WithAuthenticationToken() [1/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithAuthenticationToken ( const Aws::String value)
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 77 of file DescribeGroupsRequest.h.

◆ WithAuthenticationToken() [2/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithAuthenticationToken ( Aws::String &&  value)
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 83 of file DescribeGroupsRequest.h.

◆ WithAuthenticationToken() [3/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithAuthenticationToken ( const char *  value)
inline

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Definition at line 89 of file DescribeGroupsRequest.h.

◆ WithLimit()

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithLimit ( int  value)
inline

The maximum number of items to return with this call.

Definition at line 241 of file DescribeGroupsRequest.h.

◆ WithMarker() [1/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithMarker ( const Aws::String value)
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 208 of file DescribeGroupsRequest.h.

◆ WithMarker() [2/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithMarker ( Aws::String &&  value)
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 214 of file DescribeGroupsRequest.h.

◆ WithMarker() [3/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithMarker ( const char *  value)
inline

The marker for the next set of results. (You received this marker from a previous call.)

Definition at line 220 of file DescribeGroupsRequest.h.

◆ WithOrganizationId() [1/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithOrganizationId ( const Aws::String value)
inline

The ID of the organization.

Definition at line 161 of file DescribeGroupsRequest.h.

◆ WithOrganizationId() [2/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithOrganizationId ( Aws::String &&  value)
inline

The ID of the organization.

Definition at line 166 of file DescribeGroupsRequest.h.

◆ WithOrganizationId() [3/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithOrganizationId ( const char *  value)
inline

The ID of the organization.

Definition at line 171 of file DescribeGroupsRequest.h.

◆ WithSearchQuery() [1/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithSearchQuery ( const Aws::String value)
inline

A query to describe groups by group name.

Definition at line 120 of file DescribeGroupsRequest.h.

◆ WithSearchQuery() [2/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithSearchQuery ( Aws::String &&  value)
inline

A query to describe groups by group name.

Definition at line 125 of file DescribeGroupsRequest.h.

◆ WithSearchQuery() [3/3]

DescribeGroupsRequest& Aws::WorkDocs::Model::DescribeGroupsRequest::WithSearchQuery ( const char *  value)
inline

A query to describe groups by group name.

Definition at line 130 of file DescribeGroupsRequest.h.


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