Class: Aws::ApiGatewayV2::Types::Model

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::Model

Includes:

Structure

Defined in:

lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents a data model for an API. Supported only for WebSocket APIs. See [Create Models and Mapping Templates for Request and Response Mappings].

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content_type ⇒ String

  The content-type for the model, for example, “application/json”.

• #description ⇒ String

  The description of the model.

• #model_id ⇒ String

  The model identifier.

• #name ⇒ String

  The name of the model.

• #schema ⇒ String

  The schema for the model.

Instance Attribute Details

#content_type ⇒ String

The content-type for the model, for example, “application/json”.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5092

class Model < Struct.new(
  :content_type,
  :description,
  :model_id,
  :name,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the model.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5092

class Model < Struct.new(
  :content_type,
  :description,
  :model_id,
  :name,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end

#model_id ⇒ String

The model identifier.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5092

class Model < Struct.new(
  :content_type,
  :description,
  :model_id,
  :name,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the model. Must be alphanumeric.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5092

class Model < Struct.new(
  :content_type,
  :description,
  :model_id,
  :name,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ String

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Returns:

• (String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 5092

class Model < Struct.new(
  :content_type,
  :description,
  :model_id,
  :name,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end