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

#include <DeleteCustomMetadataRequest.h>

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

Public Member Functions

 DeleteCustomMetadataRequest ()
 
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)
 
DeleteCustomMetadataRequestWithAuthenticationToken (const Aws::String &value)
 
DeleteCustomMetadataRequestWithAuthenticationToken (Aws::String &&value)
 
DeleteCustomMetadataRequestWithAuthenticationToken (const char *value)
 
const Aws::StringGetResourceId () const
 
bool ResourceIdHasBeenSet () const
 
void SetResourceId (const Aws::String &value)
 
void SetResourceId (Aws::String &&value)
 
void SetResourceId (const char *value)
 
DeleteCustomMetadataRequestWithResourceId (const Aws::String &value)
 
DeleteCustomMetadataRequestWithResourceId (Aws::String &&value)
 
DeleteCustomMetadataRequestWithResourceId (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
DeleteCustomMetadataRequestWithVersionId (const Aws::String &value)
 
DeleteCustomMetadataRequestWithVersionId (Aws::String &&value)
 
DeleteCustomMetadataRequestWithVersionId (const char *value)
 
const Aws::Vector< Aws::String > & GetKeys () const
 
bool KeysHasBeenSet () const
 
void SetKeys (const Aws::Vector< Aws::String > &value)
 
void SetKeys (Aws::Vector< Aws::String > &&value)
 
DeleteCustomMetadataRequestWithKeys (const Aws::Vector< Aws::String > &value)
 
DeleteCustomMetadataRequestWithKeys (Aws::Vector< Aws::String > &&value)
 
DeleteCustomMetadataRequestAddKeys (const Aws::String &value)
 
DeleteCustomMetadataRequestAddKeys (Aws::String &&value)
 
DeleteCustomMetadataRequestAddKeys (const char *value)
 
bool GetDeleteAll () const
 
bool DeleteAllHasBeenSet () const
 
void SetDeleteAll (bool value)
 
DeleteCustomMetadataRequestWithDeleteAll (bool 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 DeleteCustomMetadataRequest.h.

Constructor & Destructor Documentation

◆ DeleteCustomMetadataRequest()

Aws::WorkDocs::Model::DeleteCustomMetadataRequest::DeleteCustomMetadataRequest ( )

Member Function Documentation

◆ AddKeys() [1/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::AddKeys ( const Aws::String value)
inline

List of properties to remove.

Definition at line 216 of file DeleteCustomMetadataRequest.h.

◆ AddKeys() [2/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::AddKeys ( Aws::String &&  value)
inline

List of properties to remove.

Definition at line 221 of file DeleteCustomMetadataRequest.h.

◆ AddKeys() [3/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::AddKeys ( const char *  value)
inline

List of properties to remove.

Definition at line 226 of file DeleteCustomMetadataRequest.h.

◆ AddQueryStringParameters()

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

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

Definition at line 54 of file DeleteCustomMetadataRequest.h.

◆ DeleteAllHasBeenSet()

bool Aws::WorkDocs::Model::DeleteCustomMetadataRequest::DeleteAllHasBeenSet ( ) const
inline

Flag to indicate removal of all custom metadata properties from the specified resource.

Definition at line 239 of file DeleteCustomMetadataRequest.h.

◆ GetAuthenticationToken()

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

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

Definition at line 48 of file DeleteCustomMetadataRequest.h.

◆ GetDeleteAll()

bool Aws::WorkDocs::Model::DeleteCustomMetadataRequest::GetDeleteAll ( ) const
inline

Flag to indicate removal of all custom metadata properties from the specified resource.

Definition at line 233 of file DeleteCustomMetadataRequest.h.

◆ GetKeys()

const Aws::Vector<Aws::String>& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::GetKeys ( ) const
inline

List of properties to remove.

Definition at line 186 of file DeleteCustomMetadataRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::WorkDocs::WorkDocsRequest.

◆ GetResourceId()

const Aws::String& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::GetResourceId ( ) const
inline

The ID of the resource, either a document or folder.

Definition at line 96 of file DeleteCustomMetadataRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DeleteCustomMetadataRequest.h.

◆ GetVersionId()

const Aws::String& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::GetVersionId ( ) const
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 138 of file DeleteCustomMetadataRequest.h.

◆ KeysHasBeenSet()

bool Aws::WorkDocs::Model::DeleteCustomMetadataRequest::KeysHasBeenSet ( ) const
inline

List of properties to remove.

Definition at line 191 of file DeleteCustomMetadataRequest.h.

◆ ResourceIdHasBeenSet()

bool Aws::WorkDocs::Model::DeleteCustomMetadataRequest::ResourceIdHasBeenSet ( ) const
inline

The ID of the resource, either a document or folder.

Definition at line 101 of file DeleteCustomMetadataRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthenticationToken() [1/3]

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

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

Definition at line 60 of file DeleteCustomMetadataRequest.h.

◆ SetAuthenticationToken() [2/3]

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

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

Definition at line 66 of file DeleteCustomMetadataRequest.h.

◆ SetAuthenticationToken() [3/3]

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

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

Definition at line 72 of file DeleteCustomMetadataRequest.h.

◆ SetDeleteAll()

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetDeleteAll ( bool  value)
inline

Flag to indicate removal of all custom metadata properties from the specified resource.

Definition at line 245 of file DeleteCustomMetadataRequest.h.

◆ SetKeys() [1/2]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetKeys ( const Aws::Vector< Aws::String > &  value)
inline

List of properties to remove.

Definition at line 196 of file DeleteCustomMetadataRequest.h.

◆ SetKeys() [2/2]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetKeys ( Aws::Vector< Aws::String > &&  value)
inline

List of properties to remove.

Definition at line 201 of file DeleteCustomMetadataRequest.h.

◆ SetResourceId() [1/3]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetResourceId ( const Aws::String value)
inline

The ID of the resource, either a document or folder.

Definition at line 106 of file DeleteCustomMetadataRequest.h.

◆ SetResourceId() [2/3]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetResourceId ( Aws::String &&  value)
inline

The ID of the resource, either a document or folder.

Definition at line 111 of file DeleteCustomMetadataRequest.h.

◆ SetResourceId() [3/3]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetResourceId ( const char *  value)
inline

The ID of the resource, either a document or folder.

Definition at line 116 of file DeleteCustomMetadataRequest.h.

◆ SetVersionId() [1/3]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetVersionId ( const Aws::String value)
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 150 of file DeleteCustomMetadataRequest.h.

◆ SetVersionId() [2/3]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetVersionId ( Aws::String &&  value)
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 156 of file DeleteCustomMetadataRequest.h.

◆ SetVersionId() [3/3]

void Aws::WorkDocs::Model::DeleteCustomMetadataRequest::SetVersionId ( const char *  value)
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 162 of file DeleteCustomMetadataRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::WorkDocs::Model::DeleteCustomMetadataRequest::VersionIdHasBeenSet ( ) const
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 144 of file DeleteCustomMetadataRequest.h.

◆ WithAuthenticationToken() [1/3]

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

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

Definition at line 78 of file DeleteCustomMetadataRequest.h.

◆ WithAuthenticationToken() [2/3]

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

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

Definition at line 84 of file DeleteCustomMetadataRequest.h.

◆ WithAuthenticationToken() [3/3]

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

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

Definition at line 90 of file DeleteCustomMetadataRequest.h.

◆ WithDeleteAll()

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithDeleteAll ( bool  value)
inline

Flag to indicate removal of all custom metadata properties from the specified resource.

Definition at line 251 of file DeleteCustomMetadataRequest.h.

◆ WithKeys() [1/2]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithKeys ( const Aws::Vector< Aws::String > &  value)
inline

List of properties to remove.

Definition at line 206 of file DeleteCustomMetadataRequest.h.

◆ WithKeys() [2/2]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithKeys ( Aws::Vector< Aws::String > &&  value)
inline

List of properties to remove.

Definition at line 211 of file DeleteCustomMetadataRequest.h.

◆ WithResourceId() [1/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithResourceId ( const Aws::String value)
inline

The ID of the resource, either a document or folder.

Definition at line 121 of file DeleteCustomMetadataRequest.h.

◆ WithResourceId() [2/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithResourceId ( Aws::String &&  value)
inline

The ID of the resource, either a document or folder.

Definition at line 126 of file DeleteCustomMetadataRequest.h.

◆ WithResourceId() [3/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithResourceId ( const char *  value)
inline

The ID of the resource, either a document or folder.

Definition at line 131 of file DeleteCustomMetadataRequest.h.

◆ WithVersionId() [1/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithVersionId ( const Aws::String value)
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 168 of file DeleteCustomMetadataRequest.h.

◆ WithVersionId() [2/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithVersionId ( Aws::String &&  value)
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 174 of file DeleteCustomMetadataRequest.h.

◆ WithVersionId() [3/3]

DeleteCustomMetadataRequest& Aws::WorkDocs::Model::DeleteCustomMetadataRequest::WithVersionId ( const char *  value)
inline

The ID of the version, if the custom metadata is being deleted from a document version.

Definition at line 180 of file DeleteCustomMetadataRequest.h.


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