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

#include <CreateDocumentationPartResult.h>

Public Member Functions

 CreateDocumentationPartResult ()
 
 CreateDocumentationPartResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
CreateDocumentationPartResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
CreateDocumentationPartResultWithId (const Aws::String &value)
 
CreateDocumentationPartResultWithId (Aws::String &&value)
 
CreateDocumentationPartResultWithId (const char *value)
 
const DocumentationPartLocationGetLocation () const
 
void SetLocation (const DocumentationPartLocation &value)
 
void SetLocation (DocumentationPartLocation &&value)
 
CreateDocumentationPartResultWithLocation (const DocumentationPartLocation &value)
 
CreateDocumentationPartResultWithLocation (DocumentationPartLocation &&value)
 
const Aws::StringGetProperties () const
 
void SetProperties (const Aws::String &value)
 
void SetProperties (Aws::String &&value)
 
void SetProperties (const char *value)
 
CreateDocumentationPartResultWithProperties (const Aws::String &value)
 
CreateDocumentationPartResultWithProperties (Aws::String &&value)
 
CreateDocumentationPartResultWithProperties (const char *value)
 

Detailed Description

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
Documenting an API, DocumentationParts

See Also:

AWS API Reference

Definition at line 48 of file CreateDocumentationPartResult.h.

Constructor & Destructor Documentation

◆ CreateDocumentationPartResult() [1/2]

Aws::APIGateway::Model::CreateDocumentationPartResult::CreateDocumentationPartResult ( )

◆ CreateDocumentationPartResult() [2/2]

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

Member Function Documentation

◆ GetId()

const Aws::String& Aws::APIGateway::Model::CreateDocumentationPartResult::GetId ( ) const
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 60 of file CreateDocumentationPartResult.h.

◆ GetLocation()

const DocumentationPartLocation& Aws::APIGateway::Model::CreateDocumentationPartResult::GetLocation ( ) const
inline

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.

Definition at line 106 of file CreateDocumentationPartResult.h.

◆ GetProperties()

const Aws::String& Aws::APIGateway::Model::CreateDocumentationPartResult::GetProperties ( ) const
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 154 of file CreateDocumentationPartResult.h.

◆ operator=()

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

◆ SetId() [1/3]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetId ( Aws::String &&  value)
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 72 of file CreateDocumentationPartResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetId ( const Aws::String value)
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 66 of file CreateDocumentationPartResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetId ( const char *  value)
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 78 of file CreateDocumentationPartResult.h.

◆ SetLocation() [1/2]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetLocation ( const DocumentationPartLocation value)
inline

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.

Definition at line 115 of file CreateDocumentationPartResult.h.

◆ SetLocation() [2/2]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetLocation ( DocumentationPartLocation &&  value)
inline

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.

Definition at line 124 of file CreateDocumentationPartResult.h.

◆ SetProperties() [1/3]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetProperties ( Aws::String &&  value)
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 176 of file CreateDocumentationPartResult.h.

◆ SetProperties() [2/3]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetProperties ( const Aws::String value)
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 165 of file CreateDocumentationPartResult.h.

◆ SetProperties() [3/3]

void Aws::APIGateway::Model::CreateDocumentationPartResult::SetProperties ( const char *  value)
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 187 of file CreateDocumentationPartResult.h.

◆ WithId() [1/3]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithId ( Aws::String &&  value)
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 90 of file CreateDocumentationPartResult.h.

◆ WithId() [2/3]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithId ( const Aws::String value)
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 84 of file CreateDocumentationPartResult.h.

◆ WithId() [3/3]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithId ( const char *  value)
inline

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Definition at line 96 of file CreateDocumentationPartResult.h.

◆ WithLocation() [1/2]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithLocation ( const DocumentationPartLocation value)
inline

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.

Definition at line 133 of file CreateDocumentationPartResult.h.

◆ WithLocation() [2/2]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithLocation ( DocumentationPartLocation &&  value)
inline

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.

Definition at line 142 of file CreateDocumentationPartResult.h.

◆ WithProperties() [1/3]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithProperties ( Aws::String &&  value)
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 209 of file CreateDocumentationPartResult.h.

◆ WithProperties() [2/3]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithProperties ( const Aws::String value)
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 198 of file CreateDocumentationPartResult.h.

◆ WithProperties() [3/3]

CreateDocumentationPartResult& Aws::APIGateway::Model::CreateDocumentationPartResult::WithProperties ( const char *  value)
inline

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., "{ \"description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the <literal>properties</literal> 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 x-amazon-apigateway-documentation.

Definition at line 220 of file CreateDocumentationPartResult.h.


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