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

#include <CreateModelResult.h>

Public Member Functions

 CreateModelResult ()
 
 CreateModelResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
CreateModelResultoperator= (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)
 
CreateModelResultWithId (const Aws::String &value)
 
CreateModelResultWithId (Aws::String &&value)
 
CreateModelResultWithId (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateModelResultWithName (const Aws::String &value)
 
CreateModelResultWithName (Aws::String &&value)
 
CreateModelResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateModelResultWithDescription (const Aws::String &value)
 
CreateModelResultWithDescription (Aws::String &&value)
 
CreateModelResultWithDescription (const char *value)
 
const Aws::StringGetSchema () const
 
void SetSchema (const Aws::String &value)
 
void SetSchema (Aws::String &&value)
 
void SetSchema (const char *value)
 
CreateModelResultWithSchema (const Aws::String &value)
 
CreateModelResultWithSchema (Aws::String &&value)
 
CreateModelResultWithSchema (const char *value)
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &value)
 
void SetContentType (Aws::String &&value)
 
void SetContentType (const char *value)
 
CreateModelResultWithContentType (const Aws::String &value)
 
CreateModelResultWithContentType (Aws::String &&value)
 
CreateModelResultWithContentType (const char *value)
 

Detailed Description

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

See Also:

AWS API Reference

Definition at line 41 of file CreateModelResult.h.

Constructor & Destructor Documentation

◆ CreateModelResult() [1/2]

Aws::APIGateway::Model::CreateModelResult::CreateModelResult ( )

◆ CreateModelResult() [2/2]

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

Member Function Documentation

◆ GetContentType()

const Aws::String& Aws::APIGateway::Model::CreateModelResult::GetContentType ( ) const
inline

The content-type for the model.

Definition at line 238 of file CreateModelResult.h.

◆ GetDescription()

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

The description of the model.

Definition at line 124 of file CreateModelResult.h.

◆ GetId()

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

The identifier for the model resource.

Definition at line 52 of file CreateModelResult.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::CreateModelResult::GetName ( ) const
inline

The name of the model. Must be an alphanumeric string.

Definition at line 88 of file CreateModelResult.h.

◆ GetSchema()

const Aws::String& Aws::APIGateway::Model::CreateModelResult::GetSchema ( ) const
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 166 of file CreateModelResult.h.

◆ operator=()

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

◆ SetContentType() [1/3]

void Aws::APIGateway::Model::CreateModelResult::SetContentType ( Aws::String &&  value)
inline

The content-type for the model.

Definition at line 248 of file CreateModelResult.h.

◆ SetContentType() [2/3]

void Aws::APIGateway::Model::CreateModelResult::SetContentType ( const Aws::String value)
inline

The content-type for the model.

Definition at line 243 of file CreateModelResult.h.

◆ SetContentType() [3/3]

void Aws::APIGateway::Model::CreateModelResult::SetContentType ( const char *  value)
inline

The content-type for the model.

Definition at line 253 of file CreateModelResult.h.

◆ SetDescription() [1/3]

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

The description of the model.

Definition at line 134 of file CreateModelResult.h.

◆ SetDescription() [2/3]

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

The description of the model.

Definition at line 129 of file CreateModelResult.h.

◆ SetDescription() [3/3]

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

The description of the model.

Definition at line 139 of file CreateModelResult.h.

◆ SetId() [1/3]

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

The identifier for the model resource.

Definition at line 62 of file CreateModelResult.h.

◆ SetId() [2/3]

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

The identifier for the model resource.

Definition at line 57 of file CreateModelResult.h.

◆ SetId() [3/3]

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

The identifier for the model resource.

Definition at line 67 of file CreateModelResult.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::CreateModelResult::SetName ( Aws::String &&  value)
inline

The name of the model. Must be an alphanumeric string.

Definition at line 98 of file CreateModelResult.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::CreateModelResult::SetName ( const Aws::String value)
inline

The name of the model. Must be an alphanumeric string.

Definition at line 93 of file CreateModelResult.h.

◆ SetName() [3/3]

void Aws::APIGateway::Model::CreateModelResult::SetName ( const char *  value)
inline

The name of the model. Must be an alphanumeric string.

Definition at line 103 of file CreateModelResult.h.

◆ SetSchema() [1/3]

void Aws::APIGateway::Model::CreateModelResult::SetSchema ( Aws::String &&  value)
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 188 of file CreateModelResult.h.

◆ SetSchema() [2/3]

void Aws::APIGateway::Model::CreateModelResult::SetSchema ( const Aws::String value)
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 177 of file CreateModelResult.h.

◆ SetSchema() [3/3]

void Aws::APIGateway::Model::CreateModelResult::SetSchema ( const char *  value)
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 199 of file CreateModelResult.h.

◆ WithContentType() [1/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithContentType ( Aws::String &&  value)
inline

The content-type for the model.

Definition at line 263 of file CreateModelResult.h.

◆ WithContentType() [2/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithContentType ( const Aws::String value)
inline

The content-type for the model.

Definition at line 258 of file CreateModelResult.h.

◆ WithContentType() [3/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithContentType ( const char *  value)
inline

The content-type for the model.

Definition at line 268 of file CreateModelResult.h.

◆ WithDescription() [1/3]

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

The description of the model.

Definition at line 149 of file CreateModelResult.h.

◆ WithDescription() [2/3]

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

The description of the model.

Definition at line 144 of file CreateModelResult.h.

◆ WithDescription() [3/3]

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

The description of the model.

Definition at line 154 of file CreateModelResult.h.

◆ WithId() [1/3]

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

The identifier for the model resource.

Definition at line 77 of file CreateModelResult.h.

◆ WithId() [2/3]

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

The identifier for the model resource.

Definition at line 72 of file CreateModelResult.h.

◆ WithId() [3/3]

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

The identifier for the model resource.

Definition at line 82 of file CreateModelResult.h.

◆ WithName() [1/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithName ( Aws::String &&  value)
inline

The name of the model. Must be an alphanumeric string.

Definition at line 113 of file CreateModelResult.h.

◆ WithName() [2/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithName ( const Aws::String value)
inline

The name of the model. Must be an alphanumeric string.

Definition at line 108 of file CreateModelResult.h.

◆ WithName() [3/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithName ( const char *  value)
inline

The name of the model. Must be an alphanumeric string.

Definition at line 118 of file CreateModelResult.h.

◆ WithSchema() [1/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithSchema ( Aws::String &&  value)
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 221 of file CreateModelResult.h.

◆ WithSchema() [2/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithSchema ( const Aws::String value)
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 210 of file CreateModelResult.h.

◆ WithSchema() [3/3]

CreateModelResult& Aws::APIGateway::Model::CreateModelResult::WithSchema ( const char *  value)
inline

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\* /" characters in the description of any properties because such "\* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Definition at line 232 of file CreateModelResult.h.


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