Class: Aws::APIGateway::Types::Model

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

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

<div class=“remarks” markdown=“1”> 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.

</div>

<div class=“seeAlso”> Method, MethodResponse, [Models and Mappings] </div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html

Instance Attribute Summary collapse

Instance Attribute Details

#content_type ⇒ String

The content-type for the model.

Returns:

  • (String) 


4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4481

class Model < Struct.new(
  :id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#description ⇒ String

The description of the model.

Returns:

  • (String) 


4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4481

class Model < Struct.new(
  :id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#id ⇒ String

The identifier for the model resource.

Returns:

  • (String) 


4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4481

class Model < Struct.new(
  :id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4481

class Model < Struct.new(
  :id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end

#schema ⇒ String

The schema for the model. For ‘application/json` models, this should be [JSON-schema draft v4] 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.

[1]: json-schema.org/documentation.html

Returns:

  • (String) 


4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4481

class Model < Struct.new(
  :id,
  :name,
  :description,
  :schema,
  :content_type)
  include Aws::Structure
end