113 lines
4.9 KiB
C++
113 lines
4.9 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/apigateway/APIGateway_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/apigateway/model/DocumentationPartLocation.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
template<typename RESULT_TYPE>
|
|
class AmazonWebServiceResult;
|
|
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace APIGateway
|
|
{
|
|
namespace Model
|
|
{
|
|
/**
|
|
* <p>A documentation part for a targeted API entity.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/DocumentationPart">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class CreateDocumentationPartResult
|
|
{
|
|
public:
|
|
AWS_APIGATEWAY_API CreateDocumentationPartResult();
|
|
AWS_APIGATEWAY_API CreateDocumentationPartResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
|
|
AWS_APIGATEWAY_API CreateDocumentationPartResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
|
|
|
|
|
|
///@{
|
|
/**
|
|
* <p>The DocumentationPart identifier, generated by API Gateway when the
|
|
* <code>DocumentationPart</code> is created.</p>
|
|
*/
|
|
inline const Aws::String& GetId() const{ return m_id; }
|
|
inline void SetId(const Aws::String& value) { m_id = value; }
|
|
inline void SetId(Aws::String&& value) { m_id = std::move(value); }
|
|
inline void SetId(const char* value) { m_id.assign(value); }
|
|
inline CreateDocumentationPartResult& WithId(const Aws::String& value) { SetId(value); return *this;}
|
|
inline CreateDocumentationPartResult& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;}
|
|
inline CreateDocumentationPartResult& WithId(const char* value) { SetId(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The location of the API entity to which the documentation applies. Valid
|
|
* fields depend on the targeted API entity type. All the valid location fields are
|
|
* not required. If not explicitly specified, a valid location field is treated as
|
|
* a wildcard and associated documentation content may be inherited by matching
|
|
* entities, unless overridden.</p>
|
|
*/
|
|
inline const DocumentationPartLocation& GetLocation() const{ return m_location; }
|
|
inline void SetLocation(const DocumentationPartLocation& value) { m_location = value; }
|
|
inline void SetLocation(DocumentationPartLocation&& value) { m_location = std::move(value); }
|
|
inline CreateDocumentationPartResult& WithLocation(const DocumentationPartLocation& value) { SetLocation(value); return *this;}
|
|
inline CreateDocumentationPartResult& WithLocation(DocumentationPartLocation&& value) { SetLocation(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A content map of API-specific key-value pairs describing the targeted API
|
|
* entity. The map must be encoded as a JSON string, e.g., <code>"{
|
|
* \"description\": \"The API does ...\" }"</code>. Only OpenAPI-compliant
|
|
* documentation-related fields from the properties map are exported and, hence,
|
|
* published as part of the API entity definitions, while the original
|
|
* documentation parts are exported in a OpenAPI extension of
|
|
* <code>x-amazon-apigateway-documentation</code>.</p>
|
|
*/
|
|
inline const Aws::String& GetProperties() const{ return m_properties; }
|
|
inline void SetProperties(const Aws::String& value) { m_properties = value; }
|
|
inline void SetProperties(Aws::String&& value) { m_properties = std::move(value); }
|
|
inline void SetProperties(const char* value) { m_properties.assign(value); }
|
|
inline CreateDocumentationPartResult& WithProperties(const Aws::String& value) { SetProperties(value); return *this;}
|
|
inline CreateDocumentationPartResult& WithProperties(Aws::String&& value) { SetProperties(std::move(value)); return *this;}
|
|
inline CreateDocumentationPartResult& WithProperties(const char* value) { SetProperties(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
|
|
inline const Aws::String& GetRequestId() const{ return m_requestId; }
|
|
inline void SetRequestId(const Aws::String& value) { m_requestId = value; }
|
|
inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); }
|
|
inline void SetRequestId(const char* value) { m_requestId.assign(value); }
|
|
inline CreateDocumentationPartResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;}
|
|
inline CreateDocumentationPartResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;}
|
|
inline CreateDocumentationPartResult& WithRequestId(const char* value) { SetRequestId(value); return *this;}
|
|
///@}
|
|
private:
|
|
|
|
Aws::String m_id;
|
|
|
|
DocumentationPartLocation m_location;
|
|
|
|
Aws::String m_properties;
|
|
|
|
Aws::String m_requestId;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace APIGateway
|
|
} // namespace Aws
|