AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::ListUsersRequest Class Reference

#include <ListUsersRequest.h>

+ Inheritance diagram for Aws::Transfer::Model::ListUsersRequest:

Public Member Functions

 ListUsersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListUsersRequestWithMaxResults (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)
 
ListUsersRequestWithNextToken (const Aws::String &value)
 
ListUsersRequestWithNextToken (Aws::String &&value)
 
ListUsersRequestWithNextToken (const char *value)
 
const Aws::StringGetServerId () const
 
bool ServerIdHasBeenSet () const
 
void SetServerId (const Aws::String &value)
 
void SetServerId (Aws::String &&value)
 
void SetServerId (const char *value)
 
ListUsersRequestWithServerId (const Aws::String &value)
 
ListUsersRequestWithServerId (Aws::String &&value)
 
ListUsersRequestWithServerId (const char *value)
 
- Public Member Functions inherited from Aws::Transfer::TransferRequest
virtual ~TransferRequest ()
 
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 21 of file ListUsersRequest.h.

Constructor & Destructor Documentation

◆ ListUsersRequest()

Aws::Transfer::Model::ListUsersRequest::ListUsersRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::Transfer::Model::ListUsersRequest::GetMaxResults ( ) const
inline

Specifies the number of users to return as a response to the ListUsers request.

Definition at line 41 of file ListUsersRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Transfer::Model::ListUsersRequest::GetNextToken ( ) const
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 68 of file ListUsersRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::Model::ListUsersRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetServerId()

const Aws::String& Aws::Transfer::Model::ListUsersRequest::GetServerId ( ) const
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 131 of file ListUsersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Transfer::Model::ListUsersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListUsersRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Transfer::Model::ListUsersRequest::MaxResultsHasBeenSet ( ) const
inline

Specifies the number of users to return as a response to the ListUsers request.

Definition at line 47 of file ListUsersRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Transfer::Model::ListUsersRequest::NextTokenHasBeenSet ( ) const
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 76 of file ListUsersRequest.h.

◆ SerializePayload()

Aws::String Aws::Transfer::Model::ListUsersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerIdHasBeenSet()

bool Aws::Transfer::Model::ListUsersRequest::ServerIdHasBeenSet ( ) const
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 137 of file ListUsersRequest.h.

◆ SetMaxResults()

void Aws::Transfer::Model::ListUsersRequest::SetMaxResults ( int  value)
inline

Specifies the number of users to return as a response to the ListUsers request.

Definition at line 53 of file ListUsersRequest.h.

◆ SetNextToken() [1/3]

void Aws::Transfer::Model::ListUsersRequest::SetNextToken ( Aws::String &&  value)
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 92 of file ListUsersRequest.h.

◆ SetNextToken() [2/3]

void Aws::Transfer::Model::ListUsersRequest::SetNextToken ( const Aws::String value)
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 84 of file ListUsersRequest.h.

◆ SetNextToken() [3/3]

void Aws::Transfer::Model::ListUsersRequest::SetNextToken ( const char *  value)
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 100 of file ListUsersRequest.h.

◆ SetServerId() [1/3]

void Aws::Transfer::Model::ListUsersRequest::SetServerId ( Aws::String &&  value)
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 149 of file ListUsersRequest.h.

◆ SetServerId() [2/3]

void Aws::Transfer::Model::ListUsersRequest::SetServerId ( const Aws::String value)
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 143 of file ListUsersRequest.h.

◆ SetServerId() [3/3]

void Aws::Transfer::Model::ListUsersRequest::SetServerId ( const char *  value)
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 155 of file ListUsersRequest.h.

◆ WithMaxResults()

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithMaxResults ( int  value)
inline

Specifies the number of users to return as a response to the ListUsers request.

Definition at line 59 of file ListUsersRequest.h.

◆ WithNextToken() [1/3]

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithNextToken ( Aws::String &&  value)
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 116 of file ListUsersRequest.h.

◆ WithNextToken() [2/3]

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithNextToken ( const Aws::String value)
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 108 of file ListUsersRequest.h.

◆ WithNextToken() [3/3]

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithNextToken ( const char *  value)
inline

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

Definition at line 124 of file ListUsersRequest.h.

◆ WithServerId() [1/3]

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithServerId ( Aws::String &&  value)
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 167 of file ListUsersRequest.h.

◆ WithServerId() [2/3]

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithServerId ( const Aws::String value)
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 161 of file ListUsersRequest.h.

◆ WithServerId() [3/3]

ListUsersRequest& Aws::Transfer::Model::ListUsersRequest::WithServerId ( const char *  value)
inline

A system-assigned unique identifier for a server that has users assigned to it.

Definition at line 173 of file ListUsersRequest.h.


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