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

#include <GetDocumentPathRequest.h>

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

Public Member Functions

 GetDocumentPathRequest ()
 
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)
 
GetDocumentPathRequestWithAuthenticationToken (const Aws::String &value)
 
GetDocumentPathRequestWithAuthenticationToken (Aws::String &&value)
 
GetDocumentPathRequestWithAuthenticationToken (const char *value)
 
const Aws::StringGetDocumentId () const
 
bool DocumentIdHasBeenSet () const
 
void SetDocumentId (const Aws::String &value)
 
void SetDocumentId (Aws::String &&value)
 
void SetDocumentId (const char *value)
 
GetDocumentPathRequestWithDocumentId (const Aws::String &value)
 
GetDocumentPathRequestWithDocumentId (Aws::String &&value)
 
GetDocumentPathRequestWithDocumentId (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetDocumentPathRequestWithLimit (int value)
 
const Aws::StringGetFields () const
 
bool FieldsHasBeenSet () const
 
void SetFields (const Aws::String &value)
 
void SetFields (Aws::String &&value)
 
void SetFields (const char *value)
 
GetDocumentPathRequestWithFields (const Aws::String &value)
 
GetDocumentPathRequestWithFields (Aws::String &&value)
 
GetDocumentPathRequestWithFields (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)
 
GetDocumentPathRequestWithMarker (const Aws::String &value)
 
GetDocumentPathRequestWithMarker (Aws::String &&value)
 
GetDocumentPathRequestWithMarker (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 25 of file GetDocumentPathRequest.h.

Constructor & Destructor Documentation

◆ GetDocumentPathRequest()

Aws::WorkDocs::Model::GetDocumentPathRequest::GetDocumentPathRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Definition at line 53 of file GetDocumentPathRequest.h.

◆ DocumentIdHasBeenSet()

bool Aws::WorkDocs::Model::GetDocumentPathRequest::DocumentIdHasBeenSet ( ) const
inline

The ID of the document.

Definition at line 100 of file GetDocumentPathRequest.h.

◆ FieldsHasBeenSet()

bool Aws::WorkDocs::Model::GetDocumentPathRequest::FieldsHasBeenSet ( ) const
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 164 of file GetDocumentPathRequest.h.

◆ GetAuthenticationToken()

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

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

Definition at line 47 of file GetDocumentPathRequest.h.

◆ GetDocumentId()

const Aws::String& Aws::WorkDocs::Model::GetDocumentPathRequest::GetDocumentId ( ) const
inline

The ID of the document.

Definition at line 95 of file GetDocumentPathRequest.h.

◆ GetFields()

const Aws::String& Aws::WorkDocs::Model::GetDocumentPathRequest::GetFields ( ) const
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 158 of file GetDocumentPathRequest.h.

◆ GetLimit()

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

The maximum number of levels in the hierarchy to return.

Definition at line 136 of file GetDocumentPathRequest.h.

◆ GetMarker()

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

This value is not supported.

Definition at line 206 of file GetDocumentPathRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::WorkDocs::WorkDocsRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetDocumentPathRequest.h.

◆ LimitHasBeenSet()

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

The maximum number of levels in the hierarchy to return.

Definition at line 141 of file GetDocumentPathRequest.h.

◆ MarkerHasBeenSet()

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

This value is not supported.

Definition at line 211 of file GetDocumentPathRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthenticationToken() [1/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::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 GetDocumentPathRequest.h.

◆ SetAuthenticationToken() [2/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::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 GetDocumentPathRequest.h.

◆ SetAuthenticationToken() [3/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::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 GetDocumentPathRequest.h.

◆ SetDocumentId() [1/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::SetDocumentId ( const Aws::String value)
inline

The ID of the document.

Definition at line 105 of file GetDocumentPathRequest.h.

◆ SetDocumentId() [2/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::SetDocumentId ( Aws::String &&  value)
inline

The ID of the document.

Definition at line 110 of file GetDocumentPathRequest.h.

◆ SetDocumentId() [3/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::SetDocumentId ( const char *  value)
inline

The ID of the document.

Definition at line 115 of file GetDocumentPathRequest.h.

◆ SetFields() [1/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::SetFields ( const Aws::String value)
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 170 of file GetDocumentPathRequest.h.

◆ SetFields() [2/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::SetFields ( Aws::String &&  value)
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 176 of file GetDocumentPathRequest.h.

◆ SetFields() [3/3]

void Aws::WorkDocs::Model::GetDocumentPathRequest::SetFields ( const char *  value)
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 182 of file GetDocumentPathRequest.h.

◆ SetLimit()

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

The maximum number of levels in the hierarchy to return.

Definition at line 146 of file GetDocumentPathRequest.h.

◆ SetMarker() [1/3]

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

This value is not supported.

Definition at line 216 of file GetDocumentPathRequest.h.

◆ SetMarker() [2/3]

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

This value is not supported.

Definition at line 221 of file GetDocumentPathRequest.h.

◆ SetMarker() [3/3]

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

This value is not supported.

Definition at line 226 of file GetDocumentPathRequest.h.

◆ WithAuthenticationToken() [1/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::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 GetDocumentPathRequest.h.

◆ WithAuthenticationToken() [2/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::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 GetDocumentPathRequest.h.

◆ WithAuthenticationToken() [3/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::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 GetDocumentPathRequest.h.

◆ WithDocumentId() [1/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::WithDocumentId ( const Aws::String value)
inline

The ID of the document.

Definition at line 120 of file GetDocumentPathRequest.h.

◆ WithDocumentId() [2/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::WithDocumentId ( Aws::String &&  value)
inline

The ID of the document.

Definition at line 125 of file GetDocumentPathRequest.h.

◆ WithDocumentId() [3/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::WithDocumentId ( const char *  value)
inline

The ID of the document.

Definition at line 130 of file GetDocumentPathRequest.h.

◆ WithFields() [1/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::WithFields ( const Aws::String value)
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 188 of file GetDocumentPathRequest.h.

◆ WithFields() [2/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::WithFields ( Aws::String &&  value)
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 194 of file GetDocumentPathRequest.h.

◆ WithFields() [3/3]

GetDocumentPathRequest& Aws::WorkDocs::Model::GetDocumentPathRequest::WithFields ( const char *  value)
inline

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Definition at line 200 of file GetDocumentPathRequest.h.

◆ WithLimit()

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

The maximum number of levels in the hierarchy to return.

Definition at line 151 of file GetDocumentPathRequest.h.

◆ WithMarker() [1/3]

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

This value is not supported.

Definition at line 231 of file GetDocumentPathRequest.h.

◆ WithMarker() [2/3]

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

This value is not supported.

Definition at line 236 of file GetDocumentPathRequest.h.

◆ WithMarker() [3/3]

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

This value is not supported.

Definition at line 241 of file GetDocumentPathRequest.h.


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