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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_typeString

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

Returns:

  • (String)


5092
5093
5094
5095
5096
5097
5098
5099
5100
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5092

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

#descriptionString

The description of the model.

Returns:

  • (String)


5092
5093
5094
5095
5096
5097
5098
5099
5100
# File 'gems/aws-sdk-apigatewayv2/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_idString

The model identifier.

Returns:

  • (String)


5092
5093
5094
5095
5096
5097
5098
5099
5100
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5092

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

#nameString

The name of the model. Must be alphanumeric.

Returns:

  • (String)


5092
5093
5094
5095
5096
5097
5098
5099
5100
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5092

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

#schemaString

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

Returns:

  • (String)


5092
5093
5094
5095
5096
5097
5098
5099
5100
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5092

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