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

#include <Model.h>

Public Member Functions

 Model ()
 
 Model (Aws::Utils::Json::JsonView jsonValue)
 
Modeloperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
ModelWithId (const Aws::String &value)
 
ModelWithId (Aws::String &&value)
 
ModelWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ModelWithName (const Aws::String &value)
 
ModelWithName (Aws::String &&value)
 
ModelWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ModelWithDescription (const Aws::String &value)
 
ModelWithDescription (Aws::String &&value)
 
ModelWithDescription (const char *value)
 
const Aws::StringGetSchema () const
 
bool SchemaHasBeenSet () const
 
void SetSchema (const Aws::String &value)
 
void SetSchema (Aws::String &&value)
 
void SetSchema (const char *value)
 
ModelWithSchema (const Aws::String &value)
 
ModelWithSchema (Aws::String &&value)
 
ModelWithSchema (const char *value)
 
const Aws::StringGetContentType () const
 
bool ContentTypeHasBeenSet () const
 
void SetContentType (const Aws::String &value)
 
void SetContentType (Aws::String &&value)
 
void SetContentType (const char *value)
 
ModelWithContentType (const Aws::String &value)
 
ModelWithContentType (Aws::String &&value)
 
ModelWithContentType (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 40 of file Model.h.

Constructor & Destructor Documentation

◆ Model() [1/2]

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

◆ Model() [2/2]

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

Member Function Documentation

◆ ContentTypeHasBeenSet()

bool Aws::APIGateway::Model::Model::ContentTypeHasBeenSet ( ) const
inline

The content-type for the model.

Definition at line 269 of file Model.h.

◆ DescriptionHasBeenSet()

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

The description of the model.

Definition at line 139 of file Model.h.

◆ GetContentType()

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

The content-type for the model.

Definition at line 264 of file Model.h.

◆ GetDescription()

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

The description of the model.

Definition at line 134 of file Model.h.

◆ GetId()

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

The identifier for the model resource.

Definition at line 52 of file Model.h.

◆ GetName()

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

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

Definition at line 93 of file Model.h.

◆ GetSchema()

const Aws::String& Aws::APIGateway::Model::Model::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 181 of file Model.h.

◆ IdHasBeenSet()

bool Aws::APIGateway::Model::Model::IdHasBeenSet ( ) const
inline

The identifier for the model resource.

Definition at line 57 of file Model.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

bool Aws::APIGateway::Model::Model::NameHasBeenSet ( ) const
inline

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

Definition at line 98 of file Model.h.

◆ operator=()

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

◆ SchemaHasBeenSet()

bool Aws::APIGateway::Model::Model::SchemaHasBeenSet ( ) 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 192 of file Model.h.

◆ SetContentType() [1/3]

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

The content-type for the model.

Definition at line 279 of file Model.h.

◆ SetContentType() [2/3]

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

The content-type for the model.

Definition at line 274 of file Model.h.

◆ SetContentType() [3/3]

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

The content-type for the model.

Definition at line 284 of file Model.h.

◆ SetDescription() [1/3]

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

The description of the model.

Definition at line 149 of file Model.h.

◆ SetDescription() [2/3]

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

The description of the model.

Definition at line 144 of file Model.h.

◆ SetDescription() [3/3]

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

The description of the model.

Definition at line 154 of file Model.h.

◆ SetId() [1/3]

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

The identifier for the model resource.

Definition at line 67 of file Model.h.

◆ SetId() [2/3]

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

The identifier for the model resource.

Definition at line 62 of file Model.h.

◆ SetId() [3/3]

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

The identifier for the model resource.

Definition at line 72 of file Model.h.

◆ SetName() [1/3]

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

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

Definition at line 108 of file Model.h.

◆ SetName() [2/3]

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

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

Definition at line 103 of file Model.h.

◆ SetName() [3/3]

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

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

Definition at line 113 of file Model.h.

◆ SetSchema() [1/3]

void Aws::APIGateway::Model::Model::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 214 of file Model.h.

◆ SetSchema() [2/3]

void Aws::APIGateway::Model::Model::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 203 of file Model.h.

◆ SetSchema() [3/3]

void Aws::APIGateway::Model::Model::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 225 of file Model.h.

◆ WithContentType() [1/3]

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

The content-type for the model.

Definition at line 294 of file Model.h.

◆ WithContentType() [2/3]

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

The content-type for the model.

Definition at line 289 of file Model.h.

◆ WithContentType() [3/3]

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

The content-type for the model.

Definition at line 299 of file Model.h.

◆ WithDescription() [1/3]

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

The description of the model.

Definition at line 164 of file Model.h.

◆ WithDescription() [2/3]

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

The description of the model.

Definition at line 159 of file Model.h.

◆ WithDescription() [3/3]

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

The description of the model.

Definition at line 169 of file Model.h.

◆ WithId() [1/3]

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

The identifier for the model resource.

Definition at line 82 of file Model.h.

◆ WithId() [2/3]

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

The identifier for the model resource.

Definition at line 77 of file Model.h.

◆ WithId() [3/3]

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

The identifier for the model resource.

Definition at line 87 of file Model.h.

◆ WithName() [1/3]

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

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

Definition at line 123 of file Model.h.

◆ WithName() [2/3]

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

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

Definition at line 118 of file Model.h.

◆ WithName() [3/3]

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

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

Definition at line 128 of file Model.h.

◆ WithSchema() [1/3]

Model& Aws::APIGateway::Model::Model::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 247 of file Model.h.

◆ WithSchema() [2/3]

Model& Aws::APIGateway::Model::Model::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 236 of file Model.h.

◆ WithSchema() [3/3]

Model& Aws::APIGateway::Model::Model::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 258 of file Model.h.


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