AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::GetDocumentRequest Class Reference

#include <GetDocumentRequest.h>

+ Inheritance diagram for Aws::SSM::Model::GetDocumentRequest:

Public Member Functions

 GetDocumentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GetDocumentRequestWithName (const Aws::String &value)
 
GetDocumentRequestWithName (Aws::String &&value)
 
GetDocumentRequestWithName (const char *value)
 
const Aws::StringGetVersionName () const
 
bool VersionNameHasBeenSet () const
 
void SetVersionName (const Aws::String &value)
 
void SetVersionName (Aws::String &&value)
 
void SetVersionName (const char *value)
 
GetDocumentRequestWithVersionName (const Aws::String &value)
 
GetDocumentRequestWithVersionName (Aws::String &&value)
 
GetDocumentRequestWithVersionName (const char *value)
 
const Aws::StringGetDocumentVersion () const
 
bool DocumentVersionHasBeenSet () const
 
void SetDocumentVersion (const Aws::String &value)
 
void SetDocumentVersion (Aws::String &&value)
 
void SetDocumentVersion (const char *value)
 
GetDocumentRequestWithDocumentVersion (const Aws::String &value)
 
GetDocumentRequestWithDocumentVersion (Aws::String &&value)
 
GetDocumentRequestWithDocumentVersion (const char *value)
 
const DocumentFormatGetDocumentFormat () const
 
bool DocumentFormatHasBeenSet () const
 
void SetDocumentFormat (const DocumentFormat &value)
 
void SetDocumentFormat (DocumentFormat &&value)
 
GetDocumentRequestWithDocumentFormat (const DocumentFormat &value)
 
GetDocumentRequestWithDocumentFormat (DocumentFormat &&value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
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 22 of file GetDocumentRequest.h.

Constructor & Destructor Documentation

◆ GetDocumentRequest()

Aws::SSM::Model::GetDocumentRequest::GetDocumentRequest ( )

Member Function Documentation

◆ DocumentFormatHasBeenSet()

bool Aws::SSM::Model::GetDocumentRequest::DocumentFormatHasBeenSet ( ) const
inline

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Definition at line 187 of file GetDocumentRequest.h.

◆ DocumentVersionHasBeenSet()

bool Aws::SSM::Model::GetDocumentRequest::DocumentVersionHasBeenSet ( ) const
inline

The document version for which you want information.

Definition at line 144 of file GetDocumentRequest.h.

◆ GetDocumentFormat()

const DocumentFormat& Aws::SSM::Model::GetDocumentRequest::GetDocumentFormat ( ) const
inline

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Definition at line 181 of file GetDocumentRequest.h.

◆ GetDocumentVersion()

const Aws::String& Aws::SSM::Model::GetDocumentRequest::GetDocumentVersion ( ) const
inline

The document version for which you want information.

Definition at line 139 of file GetDocumentRequest.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::GetDocumentRequest::GetName ( ) const
inline

The name of the Systems Manager document.

Definition at line 41 of file GetDocumentRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::GetDocumentRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::GetDocumentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetDocumentRequest.h.

◆ GetVersionName()

const Aws::String& Aws::SSM::Model::GetDocumentRequest::GetVersionName ( ) const
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 84 of file GetDocumentRequest.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::GetDocumentRequest::NameHasBeenSet ( ) const
inline

The name of the Systems Manager document.

Definition at line 46 of file GetDocumentRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::GetDocumentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDocumentFormat() [1/2]

void Aws::SSM::Model::GetDocumentRequest::SetDocumentFormat ( const DocumentFormat value)
inline

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Definition at line 193 of file GetDocumentRequest.h.

◆ SetDocumentFormat() [2/2]

void Aws::SSM::Model::GetDocumentRequest::SetDocumentFormat ( DocumentFormat &&  value)
inline

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Definition at line 199 of file GetDocumentRequest.h.

◆ SetDocumentVersion() [1/3]

void Aws::SSM::Model::GetDocumentRequest::SetDocumentVersion ( const Aws::String value)
inline

The document version for which you want information.

Definition at line 149 of file GetDocumentRequest.h.

◆ SetDocumentVersion() [2/3]

void Aws::SSM::Model::GetDocumentRequest::SetDocumentVersion ( Aws::String &&  value)
inline

The document version for which you want information.

Definition at line 154 of file GetDocumentRequest.h.

◆ SetDocumentVersion() [3/3]

void Aws::SSM::Model::GetDocumentRequest::SetDocumentVersion ( const char *  value)
inline

The document version for which you want information.

Definition at line 159 of file GetDocumentRequest.h.

◆ SetName() [1/3]

void Aws::SSM::Model::GetDocumentRequest::SetName ( const Aws::String value)
inline

The name of the Systems Manager document.

Definition at line 51 of file GetDocumentRequest.h.

◆ SetName() [2/3]

void Aws::SSM::Model::GetDocumentRequest::SetName ( Aws::String &&  value)
inline

The name of the Systems Manager document.

Definition at line 56 of file GetDocumentRequest.h.

◆ SetName() [3/3]

void Aws::SSM::Model::GetDocumentRequest::SetName ( const char *  value)
inline

The name of the Systems Manager document.

Definition at line 61 of file GetDocumentRequest.h.

◆ SetVersionName() [1/3]

void Aws::SSM::Model::GetDocumentRequest::SetVersionName ( const Aws::String value)
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 98 of file GetDocumentRequest.h.

◆ SetVersionName() [2/3]

void Aws::SSM::Model::GetDocumentRequest::SetVersionName ( Aws::String &&  value)
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 105 of file GetDocumentRequest.h.

◆ SetVersionName() [3/3]

void Aws::SSM::Model::GetDocumentRequest::SetVersionName ( const char *  value)
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 112 of file GetDocumentRequest.h.

◆ VersionNameHasBeenSet()

bool Aws::SSM::Model::GetDocumentRequest::VersionNameHasBeenSet ( ) const
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 91 of file GetDocumentRequest.h.

◆ WithDocumentFormat() [1/2]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithDocumentFormat ( const DocumentFormat value)
inline

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Definition at line 205 of file GetDocumentRequest.h.

◆ WithDocumentFormat() [2/2]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithDocumentFormat ( DocumentFormat &&  value)
inline

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Definition at line 211 of file GetDocumentRequest.h.

◆ WithDocumentVersion() [1/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithDocumentVersion ( const Aws::String value)
inline

The document version for which you want information.

Definition at line 164 of file GetDocumentRequest.h.

◆ WithDocumentVersion() [2/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithDocumentVersion ( Aws::String &&  value)
inline

The document version for which you want information.

Definition at line 169 of file GetDocumentRequest.h.

◆ WithDocumentVersion() [3/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithDocumentVersion ( const char *  value)
inline

The document version for which you want information.

Definition at line 174 of file GetDocumentRequest.h.

◆ WithName() [1/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithName ( const Aws::String value)
inline

The name of the Systems Manager document.

Definition at line 66 of file GetDocumentRequest.h.

◆ WithName() [2/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithName ( Aws::String &&  value)
inline

The name of the Systems Manager document.

Definition at line 71 of file GetDocumentRequest.h.

◆ WithName() [3/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithName ( const char *  value)
inline

The name of the Systems Manager document.

Definition at line 76 of file GetDocumentRequest.h.

◆ WithVersionName() [1/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithVersionName ( const Aws::String value)
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 119 of file GetDocumentRequest.h.

◆ WithVersionName() [2/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithVersionName ( Aws::String &&  value)
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 126 of file GetDocumentRequest.h.

◆ WithVersionName() [3/3]

GetDocumentRequest& Aws::SSM::Model::GetDocumentRequest::WithVersionName ( const char *  value)
inline

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Definition at line 133 of file GetDocumentRequest.h.


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