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

#include <DescribeFolderContentsRequest.h>

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

Public Member Functions

 DescribeFolderContentsRequest ()
 
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)
 
DescribeFolderContentsRequestWithAuthenticationToken (const Aws::String &value)
 
DescribeFolderContentsRequestWithAuthenticationToken (Aws::String &&value)
 
DescribeFolderContentsRequestWithAuthenticationToken (const char *value)
 
const Aws::StringGetFolderId () const
 
bool FolderIdHasBeenSet () const
 
void SetFolderId (const Aws::String &value)
 
void SetFolderId (Aws::String &&value)
 
void SetFolderId (const char *value)
 
DescribeFolderContentsRequestWithFolderId (const Aws::String &value)
 
DescribeFolderContentsRequestWithFolderId (Aws::String &&value)
 
DescribeFolderContentsRequestWithFolderId (const char *value)
 
const ResourceSortTypeGetSort () const
 
bool SortHasBeenSet () const
 
void SetSort (const ResourceSortType &value)
 
void SetSort (ResourceSortType &&value)
 
DescribeFolderContentsRequestWithSort (const ResourceSortType &value)
 
DescribeFolderContentsRequestWithSort (ResourceSortType &&value)
 
const OrderTypeGetOrder () const
 
bool OrderHasBeenSet () const
 
void SetOrder (const OrderType &value)
 
void SetOrder (OrderType &&value)
 
DescribeFolderContentsRequestWithOrder (const OrderType &value)
 
DescribeFolderContentsRequestWithOrder (OrderType &&value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeFolderContentsRequestWithLimit (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)
 
DescribeFolderContentsRequestWithMarker (const Aws::String &value)
 
DescribeFolderContentsRequestWithMarker (Aws::String &&value)
 
DescribeFolderContentsRequestWithMarker (const char *value)
 
const FolderContentTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const FolderContentType &value)
 
void SetType (FolderContentType &&value)
 
DescribeFolderContentsRequestWithType (const FolderContentType &value)
 
DescribeFolderContentsRequestWithType (FolderContentType &&value)
 
const Aws::StringGetInclude () const
 
bool IncludeHasBeenSet () const
 
void SetInclude (const Aws::String &value)
 
void SetInclude (Aws::String &&value)
 
void SetInclude (const char *value)
 
DescribeFolderContentsRequestWithInclude (const Aws::String &value)
 
DescribeFolderContentsRequestWithInclude (Aws::String &&value)
 
DescribeFolderContentsRequestWithInclude (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 28 of file DescribeFolderContentsRequest.h.

Constructor & Destructor Documentation

◆ DescribeFolderContentsRequest()

Aws::WorkDocs::Model::DescribeFolderContentsRequest::DescribeFolderContentsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Definition at line 56 of file DescribeFolderContentsRequest.h.

◆ FolderIdHasBeenSet()

bool Aws::WorkDocs::Model::DescribeFolderContentsRequest::FolderIdHasBeenSet ( ) const
inline

The ID of the folder.

Definition at line 103 of file DescribeFolderContentsRequest.h.

◆ GetAuthenticationToken()

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

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

Definition at line 50 of file DescribeFolderContentsRequest.h.

◆ GetFolderId()

const Aws::String& Aws::WorkDocs::Model::DescribeFolderContentsRequest::GetFolderId ( ) const
inline

The ID of the folder.

Definition at line 98 of file DescribeFolderContentsRequest.h.

◆ GetInclude()

const Aws::String& Aws::WorkDocs::Model::DescribeFolderContentsRequest::GetInclude ( ) const
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 303 of file DescribeFolderContentsRequest.h.

◆ GetLimit()

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

The maximum number of items to return with this call.

Definition at line 201 of file DescribeFolderContentsRequest.h.

◆ GetMarker()

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

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

Definition at line 223 of file DescribeFolderContentsRequest.h.

◆ GetOrder()

const OrderType& Aws::WorkDocs::Model::DescribeFolderContentsRequest::GetOrder ( ) const
inline

The order for the contents of the folder.

Definition at line 170 of file DescribeFolderContentsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::WorkDocs::WorkDocsRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file DescribeFolderContentsRequest.h.

◆ GetSort()

const ResourceSortType& Aws::WorkDocs::Model::DescribeFolderContentsRequest::GetSort ( ) const
inline

The sorting criteria.

Definition at line 139 of file DescribeFolderContentsRequest.h.

◆ GetType()

const FolderContentType& Aws::WorkDocs::Model::DescribeFolderContentsRequest::GetType ( ) const
inline

The type of items.

Definition at line 271 of file DescribeFolderContentsRequest.h.

◆ IncludeHasBeenSet()

bool Aws::WorkDocs::Model::DescribeFolderContentsRequest::IncludeHasBeenSet ( ) const
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 309 of file DescribeFolderContentsRequest.h.

◆ LimitHasBeenSet()

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

The maximum number of items to return with this call.

Definition at line 206 of file DescribeFolderContentsRequest.h.

◆ MarkerHasBeenSet()

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

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

Definition at line 229 of file DescribeFolderContentsRequest.h.

◆ OrderHasBeenSet()

bool Aws::WorkDocs::Model::DescribeFolderContentsRequest::OrderHasBeenSet ( ) const
inline

The order for the contents of the folder.

Definition at line 175 of file DescribeFolderContentsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthenticationToken() [1/3]

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

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

Definition at line 62 of file DescribeFolderContentsRequest.h.

◆ SetAuthenticationToken() [2/3]

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

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

Definition at line 68 of file DescribeFolderContentsRequest.h.

◆ SetAuthenticationToken() [3/3]

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

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

Definition at line 74 of file DescribeFolderContentsRequest.h.

◆ SetFolderId() [1/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetFolderId ( const Aws::String value)
inline

The ID of the folder.

Definition at line 108 of file DescribeFolderContentsRequest.h.

◆ SetFolderId() [2/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetFolderId ( Aws::String &&  value)
inline

The ID of the folder.

Definition at line 113 of file DescribeFolderContentsRequest.h.

◆ SetFolderId() [3/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetFolderId ( const char *  value)
inline

The ID of the folder.

Definition at line 118 of file DescribeFolderContentsRequest.h.

◆ SetInclude() [1/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetInclude ( const Aws::String value)
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 315 of file DescribeFolderContentsRequest.h.

◆ SetInclude() [2/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetInclude ( Aws::String &&  value)
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 321 of file DescribeFolderContentsRequest.h.

◆ SetInclude() [3/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetInclude ( const char *  value)
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 327 of file DescribeFolderContentsRequest.h.

◆ SetLimit()

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

The maximum number of items to return with this call.

Definition at line 211 of file DescribeFolderContentsRequest.h.

◆ SetMarker() [1/3]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::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 235 of file DescribeFolderContentsRequest.h.

◆ SetMarker() [2/3]

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

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

Definition at line 241 of file DescribeFolderContentsRequest.h.

◆ SetMarker() [3/3]

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

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

Definition at line 247 of file DescribeFolderContentsRequest.h.

◆ SetOrder() [1/2]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetOrder ( const OrderType value)
inline

The order for the contents of the folder.

Definition at line 180 of file DescribeFolderContentsRequest.h.

◆ SetOrder() [2/2]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetOrder ( OrderType &&  value)
inline

The order for the contents of the folder.

Definition at line 185 of file DescribeFolderContentsRequest.h.

◆ SetSort() [1/2]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetSort ( const ResourceSortType value)
inline

The sorting criteria.

Definition at line 149 of file DescribeFolderContentsRequest.h.

◆ SetSort() [2/2]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetSort ( ResourceSortType &&  value)
inline

The sorting criteria.

Definition at line 154 of file DescribeFolderContentsRequest.h.

◆ SetType() [1/2]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetType ( const FolderContentType value)
inline

The type of items.

Definition at line 281 of file DescribeFolderContentsRequest.h.

◆ SetType() [2/2]

void Aws::WorkDocs::Model::DescribeFolderContentsRequest::SetType ( FolderContentType &&  value)
inline

The type of items.

Definition at line 286 of file DescribeFolderContentsRequest.h.

◆ SortHasBeenSet()

bool Aws::WorkDocs::Model::DescribeFolderContentsRequest::SortHasBeenSet ( ) const
inline

The sorting criteria.

Definition at line 144 of file DescribeFolderContentsRequest.h.

◆ TypeHasBeenSet()

bool Aws::WorkDocs::Model::DescribeFolderContentsRequest::TypeHasBeenSet ( ) const
inline

The type of items.

Definition at line 276 of file DescribeFolderContentsRequest.h.

◆ WithAuthenticationToken() [1/3]

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

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

Definition at line 80 of file DescribeFolderContentsRequest.h.

◆ WithAuthenticationToken() [2/3]

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

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

Definition at line 86 of file DescribeFolderContentsRequest.h.

◆ WithAuthenticationToken() [3/3]

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

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

Definition at line 92 of file DescribeFolderContentsRequest.h.

◆ WithFolderId() [1/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithFolderId ( const Aws::String value)
inline

The ID of the folder.

Definition at line 123 of file DescribeFolderContentsRequest.h.

◆ WithFolderId() [2/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithFolderId ( Aws::String &&  value)
inline

The ID of the folder.

Definition at line 128 of file DescribeFolderContentsRequest.h.

◆ WithFolderId() [3/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithFolderId ( const char *  value)
inline

The ID of the folder.

Definition at line 133 of file DescribeFolderContentsRequest.h.

◆ WithInclude() [1/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithInclude ( const Aws::String value)
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 333 of file DescribeFolderContentsRequest.h.

◆ WithInclude() [2/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithInclude ( Aws::String &&  value)
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 339 of file DescribeFolderContentsRequest.h.

◆ WithInclude() [3/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithInclude ( const char *  value)
inline

The contents to include. Specify "INITIALIZED" to include initialized documents.

Definition at line 345 of file DescribeFolderContentsRequest.h.

◆ WithLimit()

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

The maximum number of items to return with this call.

Definition at line 216 of file DescribeFolderContentsRequest.h.

◆ WithMarker() [1/3]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::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 253 of file DescribeFolderContentsRequest.h.

◆ WithMarker() [2/3]

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

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

Definition at line 259 of file DescribeFolderContentsRequest.h.

◆ WithMarker() [3/3]

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

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

Definition at line 265 of file DescribeFolderContentsRequest.h.

◆ WithOrder() [1/2]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithOrder ( const OrderType value)
inline

The order for the contents of the folder.

Definition at line 190 of file DescribeFolderContentsRequest.h.

◆ WithOrder() [2/2]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithOrder ( OrderType &&  value)
inline

The order for the contents of the folder.

Definition at line 195 of file DescribeFolderContentsRequest.h.

◆ WithSort() [1/2]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithSort ( const ResourceSortType value)
inline

The sorting criteria.

Definition at line 159 of file DescribeFolderContentsRequest.h.

◆ WithSort() [2/2]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithSort ( ResourceSortType &&  value)
inline

The sorting criteria.

Definition at line 164 of file DescribeFolderContentsRequest.h.

◆ WithType() [1/2]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithType ( const FolderContentType value)
inline

The type of items.

Definition at line 291 of file DescribeFolderContentsRequest.h.

◆ WithType() [2/2]

DescribeFolderContentsRequest& Aws::WorkDocs::Model::DescribeFolderContentsRequest::WithType ( FolderContentType &&  value)
inline

The type of items.

Definition at line 296 of file DescribeFolderContentsRequest.h.


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