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

#include <GetResourcesRequest.h>

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

Public Member Functions

 GetResourcesRequest ()
 
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)
 
GetResourcesRequestWithAuthenticationToken (const Aws::String &value)
 
GetResourcesRequestWithAuthenticationToken (Aws::String &&value)
 
GetResourcesRequestWithAuthenticationToken (const char *value)
 
const Aws::StringGetUserId () const
 
bool UserIdHasBeenSet () const
 
void SetUserId (const Aws::String &value)
 
void SetUserId (Aws::String &&value)
 
void SetUserId (const char *value)
 
GetResourcesRequestWithUserId (const Aws::String &value)
 
GetResourcesRequestWithUserId (Aws::String &&value)
 
GetResourcesRequestWithUserId (const char *value)
 
const ResourceCollectionTypeGetCollectionType () const
 
bool CollectionTypeHasBeenSet () const
 
void SetCollectionType (const ResourceCollectionType &value)
 
void SetCollectionType (ResourceCollectionType &&value)
 
GetResourcesRequestWithCollectionType (const ResourceCollectionType &value)
 
GetResourcesRequestWithCollectionType (ResourceCollectionType &&value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetResourcesRequestWithLimit (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
GetResourcesRequestWithMarker (const Aws::String &value)
 
GetResourcesRequestWithMarker (Aws::String &&value)
 
GetResourcesRequestWithMarker (const char *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 26 of file GetResourcesRequest.h.

Constructor & Destructor Documentation

◆ GetResourcesRequest()

Aws::WorkDocs::Model::GetResourcesRequest::GetResourcesRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::WorkDocs::Model::GetResourcesRequest::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::GetResourcesRequest::AuthenticationTokenHasBeenSet ( ) const
inline

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

Definition at line 54 of file GetResourcesRequest.h.

◆ CollectionTypeHasBeenSet()

bool Aws::WorkDocs::Model::GetResourcesRequest::CollectionTypeHasBeenSet ( ) const
inline

The collection type.

Definition at line 150 of file GetResourcesRequest.h.

◆ GetAuthenticationToken()

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

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

Definition at line 48 of file GetResourcesRequest.h.

◆ GetCollectionType()

const ResourceCollectionType& Aws::WorkDocs::Model::GetResourcesRequest::GetCollectionType ( ) const
inline

The collection type.

Definition at line 145 of file GetResourcesRequest.h.

◆ GetLimit()

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

The maximum number of resources to return.

Definition at line 176 of file GetResourcesRequest.h.

◆ GetMarker()

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 198 of file GetResourcesRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::WorkDocs::WorkDocsRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetResourcesRequest.h.

◆ GetUserId()

const Aws::String& Aws::WorkDocs::Model::GetResourcesRequest::GetUserId ( ) const
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 97 of file GetResourcesRequest.h.

◆ LimitHasBeenSet()

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

The maximum number of resources to return.

Definition at line 181 of file GetResourcesRequest.h.

◆ MarkerHasBeenSet()

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 204 of file GetResourcesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthenticationToken() [1/3]

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

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

Definition at line 60 of file GetResourcesRequest.h.

◆ SetAuthenticationToken() [2/3]

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

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

Definition at line 66 of file GetResourcesRequest.h.

◆ SetAuthenticationToken() [3/3]

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

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

Definition at line 72 of file GetResourcesRequest.h.

◆ SetCollectionType() [1/2]

void Aws::WorkDocs::Model::GetResourcesRequest::SetCollectionType ( const ResourceCollectionType value)
inline

The collection type.

Definition at line 155 of file GetResourcesRequest.h.

◆ SetCollectionType() [2/2]

void Aws::WorkDocs::Model::GetResourcesRequest::SetCollectionType ( ResourceCollectionType &&  value)
inline

The collection type.

Definition at line 160 of file GetResourcesRequest.h.

◆ SetLimit()

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

The maximum number of resources to return.

Definition at line 186 of file GetResourcesRequest.h.

◆ SetMarker() [1/3]

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 210 of file GetResourcesRequest.h.

◆ SetMarker() [2/3]

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 216 of file GetResourcesRequest.h.

◆ SetMarker() [3/3]

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 222 of file GetResourcesRequest.h.

◆ SetUserId() [1/3]

void Aws::WorkDocs::Model::GetResourcesRequest::SetUserId ( const Aws::String value)
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 109 of file GetResourcesRequest.h.

◆ SetUserId() [2/3]

void Aws::WorkDocs::Model::GetResourcesRequest::SetUserId ( Aws::String &&  value)
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 115 of file GetResourcesRequest.h.

◆ SetUserId() [3/3]

void Aws::WorkDocs::Model::GetResourcesRequest::SetUserId ( const char *  value)
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 121 of file GetResourcesRequest.h.

◆ UserIdHasBeenSet()

bool Aws::WorkDocs::Model::GetResourcesRequest::UserIdHasBeenSet ( ) const
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 103 of file GetResourcesRequest.h.

◆ WithAuthenticationToken() [1/3]

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

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

Definition at line 78 of file GetResourcesRequest.h.

◆ WithAuthenticationToken() [2/3]

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

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

Definition at line 84 of file GetResourcesRequest.h.

◆ WithAuthenticationToken() [3/3]

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

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

Definition at line 90 of file GetResourcesRequest.h.

◆ WithCollectionType() [1/2]

GetResourcesRequest& Aws::WorkDocs::Model::GetResourcesRequest::WithCollectionType ( const ResourceCollectionType value)
inline

The collection type.

Definition at line 165 of file GetResourcesRequest.h.

◆ WithCollectionType() [2/2]

GetResourcesRequest& Aws::WorkDocs::Model::GetResourcesRequest::WithCollectionType ( ResourceCollectionType &&  value)
inline

The collection type.

Definition at line 170 of file GetResourcesRequest.h.

◆ WithLimit()

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

The maximum number of resources to return.

Definition at line 191 of file GetResourcesRequest.h.

◆ WithMarker() [1/3]

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 228 of file GetResourcesRequest.h.

◆ WithMarker() [2/3]

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 234 of file GetResourcesRequest.h.

◆ WithMarker() [3/3]

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

The marker for the next set of results. This marker was received from a previous call.

Definition at line 240 of file GetResourcesRequest.h.

◆ WithUserId() [1/3]

GetResourcesRequest& Aws::WorkDocs::Model::GetResourcesRequest::WithUserId ( const Aws::String value)
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 127 of file GetResourcesRequest.h.

◆ WithUserId() [2/3]

GetResourcesRequest& Aws::WorkDocs::Model::GetResourcesRequest::WithUserId ( Aws::String &&  value)
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 133 of file GetResourcesRequest.h.

◆ WithUserId() [3/3]

GetResourcesRequest& Aws::WorkDocs::Model::GetResourcesRequest::WithUserId ( const char *  value)
inline

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Definition at line 139 of file GetResourcesRequest.h.


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