Class: AWSCDK::APIGateway::JsonSchema

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/json_schema.rb

Overview

Represents a JSON schema definition of the structure of a REST API model.

Copied from npm module jsonschema.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(additional_items: nil, additional_properties: nil, all_of: nil, any_of: nil, contains: nil, default: nil, definitions: nil, dependencies: nil, description: nil, enum: nil, exclusive_maximum: nil, exclusive_minimum: nil, format: nil, id: nil, items: nil, maximum: nil, max_items: nil, max_length: nil, max_properties: nil, minimum: nil, min_items: nil, min_length: nil, min_properties: nil, multiple_of: nil, _not: nil, one_of: nil, pattern: nil, pattern_properties: nil, properties: nil, property_names: nil, ref: nil, required: nil, schema: nil, title: nil, type: nil, unique_items: nil) ⇒ JsonSchema

Returns a new instance of JsonSchema.

Parameters:

  • additional_items (Boolean, AWSCDK::APIGateway::JsonSchema, nil) (defaults to: nil)
  • additional_properties (Boolean, AWSCDK::APIGateway::JsonSchema, nil) (defaults to: nil)
  • all_of (Array<AWSCDK::APIGateway::JsonSchema>, nil) (defaults to: nil)
  • any_of (Array<AWSCDK::APIGateway::JsonSchema>, nil) (defaults to: nil)
  • contains (AWSCDK::APIGateway::JsonSchema, Array<AWSCDK::APIGateway::JsonSchema>, nil) (defaults to: nil)
  • default (Object, nil) (defaults to: nil)

    The default value if you use an enum.

  • definitions (Hash{String => AWSCDK::APIGateway::JsonSchema}, nil) (defaults to: nil)
  • dependencies (Hash{String => Array<String>, AWSCDK::APIGateway::JsonSchema}, nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil)
  • enum (Array<Object>, nil) (defaults to: nil)
  • exclusive_maximum (Boolean, nil) (defaults to: nil)
  • exclusive_minimum (Boolean, nil) (defaults to: nil)
  • format (String, nil) (defaults to: nil)
  • id (String, nil) (defaults to: nil)
  • items (AWSCDK::APIGateway::JsonSchema, Array<AWSCDK::APIGateway::JsonSchema>, nil) (defaults to: nil)
  • maximum (Numeric, nil) (defaults to: nil)
  • max_items (Numeric, nil) (defaults to: nil)
  • max_length (Numeric, nil) (defaults to: nil)
  • max_properties (Numeric, nil) (defaults to: nil)
  • minimum (Numeric, nil) (defaults to: nil)
  • min_items (Numeric, nil) (defaults to: nil)
  • min_length (Numeric, nil) (defaults to: nil)
  • min_properties (Numeric, nil) (defaults to: nil)
  • multiple_of (Numeric, nil) (defaults to: nil)
  • _not (AWSCDK::APIGateway::JsonSchema, nil) (defaults to: nil)
  • one_of (Array<AWSCDK::APIGateway::JsonSchema>, nil) (defaults to: nil)
  • pattern (String, nil) (defaults to: nil)
  • pattern_properties (Hash{String => AWSCDK::APIGateway::JsonSchema}, nil) (defaults to: nil)
  • properties (Hash{String => AWSCDK::APIGateway::JsonSchema}, nil) (defaults to: nil)
  • property_names (AWSCDK::APIGateway::JsonSchema, nil) (defaults to: nil)
  • ref (String, nil) (defaults to: nil)
  • required (Array<String>, nil) (defaults to: nil)
  • schema (AWSCDK::APIGateway::JsonSchemaVersion, nil) (defaults to: nil)
  • title (String, nil) (defaults to: nil)
  • type (AWSCDK::APIGateway::JsonSchemaType, Array<AWSCDK::APIGateway::JsonSchemaType>, nil) (defaults to: nil)
  • unique_items (Boolean, nil) (defaults to: nil)


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'api_gateway/json_schema.rb', line 47

def initialize(additional_items: nil, additional_properties: nil, all_of: nil, any_of: nil, contains: nil, default: nil, definitions: nil, dependencies: nil, description: nil, enum: nil, exclusive_maximum: nil, exclusive_minimum: nil, format: nil, id: nil, items: nil, maximum: nil, max_items: nil, max_length: nil, max_properties: nil, minimum: nil, min_items: nil, min_length: nil, min_properties: nil, multiple_of: nil, _not: nil, one_of: nil, pattern: nil, pattern_properties: nil, properties: nil, property_names: nil, ref: nil, required: nil, schema: nil, title: nil, type: nil, unique_items: nil)
  @additional_items = additional_items.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**additional_items.transform_keys(&:to_sym)) : additional_items
  Jsii::Type.check_type(@additional_items, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX2FwaWdhdGV3YXkuSnNvblNjaGVtYSJ9XX19")), "additionalItems") unless @additional_items.nil?
  @additional_properties = additional_properties.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**additional_properties.transform_keys(&:to_sym)) : additional_properties
  Jsii::Type.check_type(@additional_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX2FwaWdhdGV3YXkuSnNvblNjaGVtYSJ9XX19")), "additionalProperties") unless @additional_properties.nil?
  @all_of = all_of.is_a?(Array) ? all_of.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : all_of
  Jsii::Type.check_type(@all_of, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5Lkpzb25TY2hlbWEifSwia2luZCI6ImFycmF5In19")), "allOf") unless @all_of.nil?
  @any_of = any_of.is_a?(Array) ? any_of.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : any_of
  Jsii::Type.check_type(@any_of, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5Lkpzb25TY2hlbWEifSwia2luZCI6ImFycmF5In19")), "anyOf") unless @any_of.nil?
  @contains = contains.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**contains.transform_keys(&:to_sym)) : contains
  Jsii::Type.check_type(@contains, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuYXdzX2FwaWdhdGV3YXkuSnNvblNjaGVtYSJ9LHsiY29sbGVjdGlvbiI6eyJlbGVtZW50dHlwZSI6eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Kc29uU2NoZW1hIn0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "contains") unless @contains.nil?
  @default = default
  Jsii::Type.check_type(@default, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "default") unless @default.nil?
  @definitions = definitions.is_a?(Hash) ? definitions.transform_values { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : definitions
  Jsii::Type.check_type(@definitions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5Lkpzb25TY2hlbWEifSwia2luZCI6Im1hcCJ9fQ==")), "definitions") unless @definitions.nil?
  @dependencies = dependencies.is_a?(Hash) ? dependencies.transform_values { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : dependencies
  Jsii::Type.check_type(@dependencies, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Kc29uU2NoZW1hIn1dfX0sImtpbmQiOiJtYXAifX0=")), "dependencies") unless @dependencies.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @enum = enum
  Jsii::Type.check_type(@enum, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoiYXJyYXkifX0=")), "enum") unless @enum.nil?
  @exclusive_maximum = exclusive_maximum
  Jsii::Type.check_type(@exclusive_maximum, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "exclusiveMaximum") unless @exclusive_maximum.nil?
  @exclusive_minimum = exclusive_minimum
  Jsii::Type.check_type(@exclusive_minimum, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "exclusiveMinimum") unless @exclusive_minimum.nil?
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format") unless @format.nil?
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") unless @id.nil?
  @items = items.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**items.transform_keys(&:to_sym)) : items
  Jsii::Type.check_type(@items, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuYXdzX2FwaWdhdGV3YXkuSnNvblNjaGVtYSJ9LHsiY29sbGVjdGlvbiI6eyJlbGVtZW50dHlwZSI6eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Kc29uU2NoZW1hIn0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "items") unless @items.nil?
  @maximum = maximum
  Jsii::Type.check_type(@maximum, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximum") unless @maximum.nil?
  @max_items = max_items
  Jsii::Type.check_type(@max_items, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxItems") unless @max_items.nil?
  @max_length = max_length
  Jsii::Type.check_type(@max_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxLength") unless @max_length.nil?
  @max_properties = max_properties
  Jsii::Type.check_type(@max_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxProperties") unless @max_properties.nil?
  @minimum = minimum
  Jsii::Type.check_type(@minimum, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimum") unless @minimum.nil?
  @min_items = min_items
  Jsii::Type.check_type(@min_items, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minItems") unless @min_items.nil?
  @min_length = min_length
  Jsii::Type.check_type(@min_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minLength") unless @min_length.nil?
  @min_properties = min_properties
  Jsii::Type.check_type(@min_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minProperties") unless @min_properties.nil?
  @multiple_of = multiple_of
  Jsii::Type.check_type(@multiple_of, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "multipleOf") unless @multiple_of.nil?
  @_not = _not.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**_not.transform_keys(&:to_sym)) : _not
  Jsii::Type.check_type(@_not, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Kc29uU2NoZW1hIn0=")), "not") unless @_not.nil?
  @one_of = one_of.is_a?(Array) ? one_of.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : one_of
  Jsii::Type.check_type(@one_of, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5Lkpzb25TY2hlbWEifSwia2luZCI6ImFycmF5In19")), "oneOf") unless @one_of.nil?
  @pattern = pattern
  Jsii::Type.check_type(@pattern, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pattern") unless @pattern.nil?
  @pattern_properties = pattern_properties.is_a?(Hash) ? pattern_properties.transform_values { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : pattern_properties
  Jsii::Type.check_type(@pattern_properties, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5Lkpzb25TY2hlbWEifSwia2luZCI6Im1hcCJ9fQ==")), "patternProperties") unless @pattern_properties.nil?
  @properties = properties.is_a?(Hash) ? properties.transform_values { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : properties
  Jsii::Type.check_type(@properties, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5Lkpzb25TY2hlbWEifSwia2luZCI6Im1hcCJ9fQ==")), "properties") unless @properties.nil?
  @property_names = property_names.is_a?(Hash) ? ::AWSCDK::APIGateway::JsonSchema.new(**property_names.transform_keys(&:to_sym)) : property_names
  Jsii::Type.check_type(@property_names, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Kc29uU2NoZW1hIn0=")), "propertyNames") unless @property_names.nil?
  @ref = ref
  Jsii::Type.check_type(@ref, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ref") unless @ref.nil?
  @required = required
  Jsii::Type.check_type(@required, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "required") unless @required.nil?
  @schema = schema
  Jsii::Type.check_type(@schema, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5Kc29uU2NoZW1hVmVyc2lvbiJ9")), "schema") unless @schema.nil?
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless @title.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuYXdzX2FwaWdhdGV3YXkuSnNvblNjaGVtYVR5cGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsiZnFuIjoiYXdzLWNkay1saWIuYXdzX2FwaWdhdGV3YXkuSnNvblNjaGVtYVR5cGUifSwia2luZCI6ImFycmF5In19XX19")), "type") unless @type.nil?
  @unique_items = unique_items
  Jsii::Type.check_type(@unique_items, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "uniqueItems") unless @unique_items.nil?
end

Instance Attribute Details

#_notAWSCDK::APIGateway::JsonSchema? (readonly)

Returns:

  • (AWSCDK::APIGateway::JsonSchema, nil)


174
175
176
# File 'api_gateway/json_schema.rb', line 174

def _not
  @_not
end

#additional_itemsBoolean, ... (readonly)

Returns:

  • (Boolean, AWSCDK::APIGateway::JsonSchema, nil)


123
124
125
# File 'api_gateway/json_schema.rb', line 123

def additional_items
  @additional_items
end

#additional_propertiesBoolean, ... (readonly)

Returns:

  • (Boolean, AWSCDK::APIGateway::JsonSchema, nil)


125
126
127
# File 'api_gateway/json_schema.rb', line 125

def additional_properties
  @additional_properties
end

#all_ofArray<AWSCDK::APIGateway::JsonSchema>? (readonly)

Returns:

  • (Array<AWSCDK::APIGateway::JsonSchema>, nil)


127
128
129
# File 'api_gateway/json_schema.rb', line 127

def all_of
  @all_of
end

#any_ofArray<AWSCDK::APIGateway::JsonSchema>? (readonly)

Returns:

  • (Array<AWSCDK::APIGateway::JsonSchema>, nil)


129
130
131
# File 'api_gateway/json_schema.rb', line 129

def any_of
  @any_of
end

#containsAWSCDK::APIGateway::JsonSchema, ... (readonly)

Returns:

  • (AWSCDK::APIGateway::JsonSchema, Array<AWSCDK::APIGateway::JsonSchema>, nil)


131
132
133
# File 'api_gateway/json_schema.rb', line 131

def contains
  @contains
end

#defaultObject? (readonly)

Note:

Default: - not set

The default value if you use an enum.

Returns:

  • (Object, nil)


136
137
138
# File 'api_gateway/json_schema.rb', line 136

def default
  @default
end

#definitionsHash{String => AWSCDK::APIGateway::JsonSchema}? (readonly)

Returns:

  • (Hash{String => AWSCDK::APIGateway::JsonSchema}, nil)


138
139
140
# File 'api_gateway/json_schema.rb', line 138

def definitions
  @definitions
end

#dependenciesHash{String => Array<String>, AWSCDK::APIGateway::JsonSchema}? (readonly)

Returns:

  • (Hash{String => Array<String>, AWSCDK::APIGateway::JsonSchema}, nil)


140
141
142
# File 'api_gateway/json_schema.rb', line 140

def dependencies
  @dependencies
end

#descriptionString? (readonly)

Returns:

  • (String, nil)


142
143
144
# File 'api_gateway/json_schema.rb', line 142

def description
  @description
end

#enumArray<Object>? (readonly)

Returns:

  • (Array<Object>, nil)


144
145
146
# File 'api_gateway/json_schema.rb', line 144

def enum
  @enum
end

#exclusive_maximumBoolean? (readonly)

Returns:

  • (Boolean, nil)


146
147
148
# File 'api_gateway/json_schema.rb', line 146

def exclusive_maximum
  @exclusive_maximum
end

#exclusive_minimumBoolean? (readonly)

Returns:

  • (Boolean, nil)


148
149
150
# File 'api_gateway/json_schema.rb', line 148

def exclusive_minimum
  @exclusive_minimum
end

#formatString? (readonly)

Returns:

  • (String, nil)


150
151
152
# File 'api_gateway/json_schema.rb', line 150

def format
  @format
end

#idString? (readonly)

Returns:

  • (String, nil)


152
153
154
# File 'api_gateway/json_schema.rb', line 152

def id
  @id
end

#itemsAWSCDK::APIGateway::JsonSchema, ... (readonly)

Returns:

  • (AWSCDK::APIGateway::JsonSchema, Array<AWSCDK::APIGateway::JsonSchema>, nil)


154
155
156
# File 'api_gateway/json_schema.rb', line 154

def items
  @items
end

#max_itemsNumeric? (readonly)

Returns:

  • (Numeric, nil)


158
159
160
# File 'api_gateway/json_schema.rb', line 158

def max_items
  @max_items
end

#max_lengthNumeric? (readonly)

Returns:

  • (Numeric, nil)


160
161
162
# File 'api_gateway/json_schema.rb', line 160

def max_length
  @max_length
end

#max_propertiesNumeric? (readonly)

Returns:

  • (Numeric, nil)


162
163
164
# File 'api_gateway/json_schema.rb', line 162

def max_properties
  @max_properties
end

#maximumNumeric? (readonly)

Returns:

  • (Numeric, nil)


156
157
158
# File 'api_gateway/json_schema.rb', line 156

def maximum
  @maximum
end

#min_itemsNumeric? (readonly)

Returns:

  • (Numeric, nil)


166
167
168
# File 'api_gateway/json_schema.rb', line 166

def min_items
  @min_items
end

#min_lengthNumeric? (readonly)

Returns:

  • (Numeric, nil)


168
169
170
# File 'api_gateway/json_schema.rb', line 168

def min_length
  @min_length
end

#min_propertiesNumeric? (readonly)

Returns:

  • (Numeric, nil)


170
171
172
# File 'api_gateway/json_schema.rb', line 170

def min_properties
  @min_properties
end

#minimumNumeric? (readonly)

Returns:

  • (Numeric, nil)


164
165
166
# File 'api_gateway/json_schema.rb', line 164

def minimum
  @minimum
end

#multiple_ofNumeric? (readonly)

Returns:

  • (Numeric, nil)


172
173
174
# File 'api_gateway/json_schema.rb', line 172

def multiple_of
  @multiple_of
end

#one_ofArray<AWSCDK::APIGateway::JsonSchema>? (readonly)

Returns:

  • (Array<AWSCDK::APIGateway::JsonSchema>, nil)


176
177
178
# File 'api_gateway/json_schema.rb', line 176

def one_of
  @one_of
end

#patternString? (readonly)

Returns:

  • (String, nil)


178
179
180
# File 'api_gateway/json_schema.rb', line 178

def pattern
  @pattern
end

#pattern_propertiesHash{String => AWSCDK::APIGateway::JsonSchema}? (readonly)

Returns:

  • (Hash{String => AWSCDK::APIGateway::JsonSchema}, nil)


180
181
182
# File 'api_gateway/json_schema.rb', line 180

def pattern_properties
  @pattern_properties
end

#propertiesHash{String => AWSCDK::APIGateway::JsonSchema}? (readonly)

Returns:

  • (Hash{String => AWSCDK::APIGateway::JsonSchema}, nil)


182
183
184
# File 'api_gateway/json_schema.rb', line 182

def properties
  @properties
end

#property_namesAWSCDK::APIGateway::JsonSchema? (readonly)

Returns:

  • (AWSCDK::APIGateway::JsonSchema, nil)


184
185
186
# File 'api_gateway/json_schema.rb', line 184

def property_names
  @property_names
end

#refString? (readonly)

Returns:

  • (String, nil)


186
187
188
# File 'api_gateway/json_schema.rb', line 186

def ref
  @ref
end

#requiredArray<String>? (readonly)

Returns:

  • (Array<String>, nil)


188
189
190
# File 'api_gateway/json_schema.rb', line 188

def required
  @required
end

#schemaAWSCDK::APIGateway::JsonSchemaVersion? (readonly)



190
191
192
# File 'api_gateway/json_schema.rb', line 190

def schema
  @schema
end

#titleString? (readonly)

Returns:

  • (String, nil)


192
193
194
# File 'api_gateway/json_schema.rb', line 192

def title
  @title
end

#typeAWSCDK::APIGateway::JsonSchemaType, ... (readonly)



194
195
196
# File 'api_gateway/json_schema.rb', line 194

def type
  @type
end

#unique_itemsBoolean? (readonly)

Returns:

  • (Boolean, nil)


196
197
198
# File 'api_gateway/json_schema.rb', line 196

def unique_items
  @unique_items
end

Class Method Details

.jsii_propertiesObject



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'api_gateway/json_schema.rb', line 198

def self.jsii_properties
  {
    :additional_items => "additionalItems",
    :additional_properties => "additionalProperties",
    :all_of => "allOf",
    :any_of => "anyOf",
    :contains => "contains",
    :default => "default",
    :definitions => "definitions",
    :dependencies => "dependencies",
    :description => "description",
    :enum => "enum",
    :exclusive_maximum => "exclusiveMaximum",
    :exclusive_minimum => "exclusiveMinimum",
    :format => "format",
    :id => "id",
    :items => "items",
    :maximum => "maximum",
    :max_items => "maxItems",
    :max_length => "maxLength",
    :max_properties => "maxProperties",
    :minimum => "minimum",
    :min_items => "minItems",
    :min_length => "minLength",
    :min_properties => "minProperties",
    :multiple_of => "multipleOf",
    :_not => "not",
    :one_of => "oneOf",
    :pattern => "pattern",
    :pattern_properties => "patternProperties",
    :properties => "properties",
    :property_names => "propertyNames",
    :ref => "ref",
    :required => "required",
    :schema => "schema",
    :title => "title",
    :type => "type",
    :unique_items => "uniqueItems",
  }
end

Instance Method Details

#to_jsiiObject



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'api_gateway/json_schema.rb', line 239

def to_jsii
  result = {}
  result.merge!({
    "additionalItems" => @additional_items,
    "additionalProperties" => @additional_properties,
    "allOf" => @all_of,
    "anyOf" => @any_of,
    "contains" => @contains,
    "default" => @default,
    "definitions" => @definitions,
    "dependencies" => @dependencies,
    "description" => @description,
    "enum" => @enum,
    "exclusiveMaximum" => @exclusive_maximum,
    "exclusiveMinimum" => @exclusive_minimum,
    "format" => @format,
    "id" => @id,
    "items" => @items,
    "maximum" => @maximum,
    "maxItems" => @max_items,
    "maxLength" => @max_length,
    "maxProperties" => @max_properties,
    "minimum" => @minimum,
    "minItems" => @min_items,
    "minLength" => @min_length,
    "minProperties" => @min_properties,
    "multipleOf" => @multiple_of,
    "not" => @_not,
    "oneOf" => @one_of,
    "pattern" => @pattern,
    "patternProperties" => @pattern_properties,
    "properties" => @properties,
    "propertyNames" => @property_names,
    "ref" => @ref,
    "required" => @required,
    "schema" => @schema,
    "title" => @title,
    "type" => @type,
    "uniqueItems" => @unique_items,
  })
  result.compact
end