Class: Google::Apis::ConnectorsV1::JsonSchema
- Inherits:
-
Object
- Object
- Google::Apis::ConnectorsV1::JsonSchema
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/connectors_v1/classes.rb,
lib/google/apis/connectors_v1/representations.rb,
lib/google/apis/connectors_v1/representations.rb
Overview
JsonSchema representation of schema metadata
Instance Attribute Summary collapse
-
#default ⇒ Object
The default value of the field or object described by this schema.
-
#description ⇒ String
A description of this schema.
-
#enum ⇒ Array<Object>
Possible values for an enumeration.
-
#format ⇒ String
Format of the value as per https://json-schema.org/understanding-json-schema/ reference/string.html#format Corresponds to the JSON property
format. -
#items ⇒ Google::Apis::ConnectorsV1::JsonSchema
JsonSchema representation of schema metadata Corresponds to the JSON property
items. -
#jdbc_type ⇒ String
JDBC datatype of the field.
-
#properties ⇒ Hash<String,Google::Apis::ConnectorsV1::JsonSchema>
The child schemas, applicable only if this is of type
object. -
#required ⇒ Array<String>
Whether this property is required.
-
#type ⇒ Array<String>
JSON Schema Validation: A Vocabulary for Structural Validation of JSON Corresponds to the JSON property
type.
Instance Method Summary collapse
-
#initialize(**args) ⇒ JsonSchema
constructor
A new instance of JsonSchema.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ JsonSchema
Returns a new instance of JsonSchema.
2206 2207 2208 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2206 def initialize(**args) update!(**args) end |
Instance Attribute Details
#default ⇒ Object
The default value of the field or object described by this schema.
Corresponds to the JSON property default
2160 2161 2162 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2160 def default @default end |
#description ⇒ String
A description of this schema.
Corresponds to the JSON property description
2165 2166 2167 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2165 def description @description end |
#enum ⇒ Array<Object>
Possible values for an enumeration. This works in conjunction with type to
represent types with a fixed set of legal values
Corresponds to the JSON property enum
2171 2172 2173 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2171 def enum @enum end |
#format ⇒ String
Format of the value as per https://json-schema.org/understanding-json-schema/
reference/string.html#format
Corresponds to the JSON property format
2177 2178 2179 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2177 def format @format end |
#items ⇒ Google::Apis::ConnectorsV1::JsonSchema
JsonSchema representation of schema metadata
Corresponds to the JSON property items
2182 2183 2184 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2182 def items @items end |
#jdbc_type ⇒ String
JDBC datatype of the field.
Corresponds to the JSON property jdbcType
2187 2188 2189 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2187 def jdbc_type @jdbc_type end |
#properties ⇒ Hash<String,Google::Apis::ConnectorsV1::JsonSchema>
The child schemas, applicable only if this is of type object. The key is the
name of the property and the value is the json schema that describes that
property
Corresponds to the JSON property properties
2194 2195 2196 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2194 def properties @properties end |
#required ⇒ Array<String>
Whether this property is required.
Corresponds to the JSON property required
2199 2200 2201 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2199 def required @required end |
#type ⇒ Array<String>
JSON Schema Validation: A Vocabulary for Structural Validation of JSON
Corresponds to the JSON property type
2204 2205 2206 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2204 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2211 def update!(**args) @default = args[:default] if args.key?(:default) @description = args[:description] if args.key?(:description) @enum = args[:enum] if args.key?(:enum) @format = args[:format] if args.key?(:format) @items = args[:items] if args.key?(:items) @jdbc_type = args[:jdbc_type] if args.key?(:jdbc_type) @properties = args[:properties] if args.key?(:properties) @required = args[:required] if args.key?(:required) @type = args[:type] if args.key?(:type) end |