AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::GetDocumentationVersionResult Class Reference

#include <GetDocumentationVersionResult.h>

Public Member Functions

 GetDocumentationVersionResult ()
 
 GetDocumentationVersionResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetDocumentationVersionResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetVersion () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
GetDocumentationVersionResultWithVersion (const Aws::String &value)
 
GetDocumentationVersionResultWithVersion (Aws::String &&value)
 
GetDocumentationVersionResultWithVersion (const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
GetDocumentationVersionResultWithCreatedDate (const Aws::Utils::DateTime &value)
 
GetDocumentationVersionResultWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
GetDocumentationVersionResultWithDescription (const Aws::String &value)
 
GetDocumentationVersionResultWithDescription (Aws::String &&value)
 
GetDocumentationVersionResultWithDescription (const char *value)
 

Detailed Description

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.
Documenting an API, DocumentationPart, DocumentationVersions

See Also:

AWS API Reference

Definition at line 40 of file GetDocumentationVersionResult.h.

Constructor & Destructor Documentation

◆ GetDocumentationVersionResult() [1/2]

Aws::APIGateway::Model::GetDocumentationVersionResult::GetDocumentationVersionResult ( )

◆ GetDocumentationVersionResult() [2/2]

Aws::APIGateway::Model::GetDocumentationVersionResult::GetDocumentationVersionResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::GetDocumentationVersionResult::GetCreatedDate ( ) const
inline

The date when the API documentation snapshot is created.

Definition at line 87 of file GetDocumentationVersionResult.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::GetDocumentationVersionResult::GetDescription ( ) const
inline

The description of the API documentation snapshot.

Definition at line 113 of file GetDocumentationVersionResult.h.

◆ GetVersion()

const Aws::String& Aws::APIGateway::Model::GetDocumentationVersionResult::GetVersion ( ) const
inline

The version identifier of the API documentation snapshot.

Definition at line 51 of file GetDocumentationVersionResult.h.

◆ operator=()

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCreatedDate() [1/2]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date when the API documentation snapshot is created.

Definition at line 97 of file GetDocumentationVersionResult.h.

◆ SetCreatedDate() [2/2]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The date when the API documentation snapshot is created.

Definition at line 92 of file GetDocumentationVersionResult.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetDescription ( Aws::String &&  value)
inline

The description of the API documentation snapshot.

Definition at line 123 of file GetDocumentationVersionResult.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetDescription ( const Aws::String value)
inline

The description of the API documentation snapshot.

Definition at line 118 of file GetDocumentationVersionResult.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetDescription ( const char *  value)
inline

The description of the API documentation snapshot.

Definition at line 128 of file GetDocumentationVersionResult.h.

◆ SetVersion() [1/3]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetVersion ( Aws::String &&  value)
inline

The version identifier of the API documentation snapshot.

Definition at line 61 of file GetDocumentationVersionResult.h.

◆ SetVersion() [2/3]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetVersion ( const Aws::String value)
inline

The version identifier of the API documentation snapshot.

Definition at line 56 of file GetDocumentationVersionResult.h.

◆ SetVersion() [3/3]

void Aws::APIGateway::Model::GetDocumentationVersionResult::SetVersion ( const char *  value)
inline

The version identifier of the API documentation snapshot.

Definition at line 66 of file GetDocumentationVersionResult.h.

◆ WithCreatedDate() [1/2]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date when the API documentation snapshot is created.

Definition at line 107 of file GetDocumentationVersionResult.h.

◆ WithCreatedDate() [2/2]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The date when the API documentation snapshot is created.

Definition at line 102 of file GetDocumentationVersionResult.h.

◆ WithDescription() [1/3]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithDescription ( Aws::String &&  value)
inline

The description of the API documentation snapshot.

Definition at line 138 of file GetDocumentationVersionResult.h.

◆ WithDescription() [2/3]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithDescription ( const Aws::String value)
inline

The description of the API documentation snapshot.

Definition at line 133 of file GetDocumentationVersionResult.h.

◆ WithDescription() [3/3]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithDescription ( const char *  value)
inline

The description of the API documentation snapshot.

Definition at line 143 of file GetDocumentationVersionResult.h.

◆ WithVersion() [1/3]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithVersion ( Aws::String &&  value)
inline

The version identifier of the API documentation snapshot.

Definition at line 76 of file GetDocumentationVersionResult.h.

◆ WithVersion() [2/3]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithVersion ( const Aws::String value)
inline

The version identifier of the API documentation snapshot.

Definition at line 71 of file GetDocumentationVersionResult.h.

◆ WithVersion() [3/3]

GetDocumentationVersionResult& Aws::APIGateway::Model::GetDocumentationVersionResult::WithVersion ( const char *  value)
inline

The version identifier of the API documentation snapshot.

Definition at line 81 of file GetDocumentationVersionResult.h.


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