/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace APIGateway { namespace Model { /** *

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.

See Also:

AWS * API Reference

*/ class AWS_APIGATEWAY_API DocumentationVersion { public: DocumentationVersion(); DocumentationVersion(Aws::Utils::Json::JsonView jsonValue); DocumentationVersion& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

The version identifier of the API documentation snapshot.

*/ inline const Aws::String& GetVersion() const{ return m_version; } /** *

The version identifier of the API documentation snapshot.

*/ inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; } /** *

The version identifier of the API documentation snapshot.

*/ inline void SetVersion(const Aws::String& value) { m_versionHasBeenSet = true; m_version = value; } /** *

The version identifier of the API documentation snapshot.

*/ inline void SetVersion(Aws::String&& value) { m_versionHasBeenSet = true; m_version = std::move(value); } /** *

The version identifier of the API documentation snapshot.

*/ inline void SetVersion(const char* value) { m_versionHasBeenSet = true; m_version.assign(value); } /** *

The version identifier of the API documentation snapshot.

*/ inline DocumentationVersion& WithVersion(const Aws::String& value) { SetVersion(value); return *this;} /** *

The version identifier of the API documentation snapshot.

*/ inline DocumentationVersion& WithVersion(Aws::String&& value) { SetVersion(std::move(value)); return *this;} /** *

The version identifier of the API documentation snapshot.

*/ inline DocumentationVersion& WithVersion(const char* value) { SetVersion(value); return *this;} /** *

The date when the API documentation snapshot is created.

*/ inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; } /** *

The date when the API documentation snapshot is created.

*/ inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; } /** *

The date when the API documentation snapshot is created.

*/ inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDateHasBeenSet = true; m_createdDate = value; } /** *

The date when the API documentation snapshot is created.

*/ inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::move(value); } /** *

The date when the API documentation snapshot is created.

*/ inline DocumentationVersion& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;} /** *

The date when the API documentation snapshot is created.

*/ inline DocumentationVersion& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;} /** *

The description of the API documentation snapshot.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description of the API documentation snapshot.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description of the API documentation snapshot.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description of the API documentation snapshot.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description of the API documentation snapshot.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description of the API documentation snapshot.

*/ inline DocumentationVersion& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the API documentation snapshot.

*/ inline DocumentationVersion& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description of the API documentation snapshot.

*/ inline DocumentationVersion& WithDescription(const char* value) { SetDescription(value); return *this;} private: Aws::String m_version; bool m_versionHasBeenSet; Aws::Utils::DateTime m_createdDate; bool m_createdDateHasBeenSet; Aws::String m_description; bool m_descriptionHasBeenSet; }; } // namespace Model } // namespace APIGateway } // namespace Aws