Class: Google::Apis::ConnectorsV2::JsonSchema

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/connectors_v2/classes.rb,
lib/google/apis/connectors_v2/representations.rb,
lib/google/apis/connectors_v2/representations.rb

Overview

JsonSchema representation of schema metadata

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JsonSchema

Returns a new instance of JsonSchema.



435
436
437
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 435

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_details ⇒ Hash<String,Object>

Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema Corresponds to the JSON property additionalDetails

Returns:

  • (Hash<String,Object>) 


384
385
386
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 384

def additional_details
  @additional_details
end

#default ⇒ Object

The default value of the field or object described by this schema. Corresponds to the JSON property default

Returns:

  • (Object) 


389
390
391
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 389

def default
  @default
end

#description ⇒ String

A description of this schema. Corresponds to the JSON property description

Returns:

  • (String) 


394
395
396
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 394

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

Returns:

  • (Array<Object>) 


400
401
402
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 400

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

Returns:

  • (String) 


406
407
408
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 406

def format
  @format
end

#items ⇒ Google::Apis::ConnectorsV2::JsonSchema

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



411
412
413
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 411

def items
  @items
end

#jdbc_type ⇒ String

JDBC datatype of the field. Corresponds to the JSON property jdbcType

Returns:

  • (String) 


416
417
418
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 416

def jdbc_type
  @jdbc_type
end

#properties ⇒ Hash<String,Google::Apis::ConnectorsV2::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

Returns:



423
424
425
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 423

def properties
  @properties
end

#required ⇒ Array<String>

Whether this property is required. Corresponds to the JSON property required

Returns:

  • (Array<String>) 


428
429
430
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 428

def required
  @required
end

#type ⇒ Array<String>

JSON Schema Validation: A Vocabulary for Structural Validation of JSON Corresponds to the JSON property type

Returns:

  • (Array<String>) 


433
434
435
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 433

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 440

def update!(**args)
  @additional_details = args[:additional_details] if args.key?(:additional_details)
  @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