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.
3362 3363 3364 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3362 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
3316 3317 3318 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3316 def default @default end |
#description ⇒ String
A description of this schema.
Corresponds to the JSON property description
3321 3322 3323 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3321 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
3327 3328 3329 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3327 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
3333 3334 3335 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3333 def format @format end |
#items ⇒ Google::Apis::ConnectorsV1::JsonSchema
JsonSchema representation of schema metadata
Corresponds to the JSON property items
3338 3339 3340 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3338 def items @items end |
#jdbc_type ⇒ String
JDBC datatype of the field.
Corresponds to the JSON property jdbcType
3343 3344 3345 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3343 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
3350 3351 3352 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3350 def properties @properties end |
#required ⇒ Array<String>
Whether this property is required.
Corresponds to the JSON property required
3355 3356 3357 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3355 def required @required end |
#type ⇒ Array<String>
JSON Schema Validation: A Vocabulary for Structural Validation of JSON
Corresponds to the JSON property type
3360 3361 3362 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3360 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 3367 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 |