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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_typeString

The content-type for the model.

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-apigateway/types.rb', line 4719

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

#descriptionString

The description of the model.

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-apigateway/types.rb', line 4719

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

#idString

The identifier for the model resource.

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-apigateway/types.rb', line 4719

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

#nameString

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

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-apigateway/types.rb', line 4719

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

#schemaString

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.

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-apigateway/types.rb', line 4719

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