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

#include <DocumentationVersion.h>

Public Member Functions

 DocumentationVersion ()
 
 DocumentationVersion (Aws::Utils::Json::JsonView jsonValue)
 
DocumentationVersionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
DocumentationVersionWithVersion (const Aws::String &value)
 
DocumentationVersionWithVersion (Aws::String &&value)
 
DocumentationVersionWithVersion (const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
DocumentationVersionWithCreatedDate (const Aws::Utils::DateTime &value)
 
DocumentationVersionWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
DocumentationVersionWithDescription (const Aws::String &value)
 
DocumentationVersionWithDescription (Aws::String &&value)
 
DocumentationVersionWithDescription (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 39 of file DocumentationVersion.h.

Constructor & Destructor Documentation

◆ DocumentationVersion() [1/2]

Aws::APIGateway::Model::DocumentationVersion::DocumentationVersion ( )

◆ DocumentationVersion() [2/2]

Aws::APIGateway::Model::DocumentationVersion::DocumentationVersion ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreatedDateHasBeenSet()

bool Aws::APIGateway::Model::DocumentationVersion::CreatedDateHasBeenSet ( ) const
inline

The date when the API documentation snapshot is created.

Definition at line 97 of file DocumentationVersion.h.

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::DocumentationVersion::DescriptionHasBeenSet ( ) const
inline

The description of the API documentation snapshot.

Definition at line 128 of file DocumentationVersion.h.

◆ GetCreatedDate()

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

The date when the API documentation snapshot is created.

Definition at line 92 of file DocumentationVersion.h.

◆ GetDescription()

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

The description of the API documentation snapshot.

Definition at line 123 of file DocumentationVersion.h.

◆ GetVersion()

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

The version identifier of the API documentation snapshot.

Definition at line 51 of file DocumentationVersion.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::DocumentationVersion::Jsonize ( ) const

◆ operator=()

DocumentationVersion& Aws::APIGateway::Model::DocumentationVersion::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCreatedDate() [1/2]

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

The date when the API documentation snapshot is created.

Definition at line 107 of file DocumentationVersion.h.

◆ SetCreatedDate() [2/2]

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

The date when the API documentation snapshot is created.

Definition at line 102 of file DocumentationVersion.h.

◆ SetDescription() [1/3]

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

The description of the API documentation snapshot.

Definition at line 138 of file DocumentationVersion.h.

◆ SetDescription() [2/3]

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

The description of the API documentation snapshot.

Definition at line 133 of file DocumentationVersion.h.

◆ SetDescription() [3/3]

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

The description of the API documentation snapshot.

Definition at line 143 of file DocumentationVersion.h.

◆ SetVersion() [1/3]

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

The version identifier of the API documentation snapshot.

Definition at line 66 of file DocumentationVersion.h.

◆ SetVersion() [2/3]

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

The version identifier of the API documentation snapshot.

Definition at line 61 of file DocumentationVersion.h.

◆ SetVersion() [3/3]

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

The version identifier of the API documentation snapshot.

Definition at line 71 of file DocumentationVersion.h.

◆ VersionHasBeenSet()

bool Aws::APIGateway::Model::DocumentationVersion::VersionHasBeenSet ( ) const
inline

The version identifier of the API documentation snapshot.

Definition at line 56 of file DocumentationVersion.h.

◆ WithCreatedDate() [1/2]

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

The date when the API documentation snapshot is created.

Definition at line 117 of file DocumentationVersion.h.

◆ WithCreatedDate() [2/2]

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

The date when the API documentation snapshot is created.

Definition at line 112 of file DocumentationVersion.h.

◆ WithDescription() [1/3]

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

The description of the API documentation snapshot.

Definition at line 153 of file DocumentationVersion.h.

◆ WithDescription() [2/3]

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

The description of the API documentation snapshot.

Definition at line 148 of file DocumentationVersion.h.

◆ WithDescription() [3/3]

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

The description of the API documentation snapshot.

Definition at line 158 of file DocumentationVersion.h.

◆ WithVersion() [1/3]

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

The version identifier of the API documentation snapshot.

Definition at line 81 of file DocumentationVersion.h.

◆ WithVersion() [2/3]

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

The version identifier of the API documentation snapshot.

Definition at line 76 of file DocumentationVersion.h.

◆ WithVersion() [3/3]

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

The version identifier of the API documentation snapshot.

Definition at line 86 of file DocumentationVersion.h.


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