Class: Google::Apis::ConnectorsV1::JsonSchema

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JsonSchema

Returns a new instance of JsonSchema.



2752
2753
2754
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2752

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

Returns:

  • (Object) 


2706
2707
2708
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2706

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


2711
2712
2713
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2711

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>) 


2717
2718
2719
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2717

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) 


2723
2724
2725
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2723

def format
  @format
end

#items ⇒ Google::Apis::ConnectorsV1::JsonSchema

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



2728
2729
2730
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2728

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


2733
2734
2735
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2733

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

Returns:



2740
2741
2742
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2740

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2745
2746
2747
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2745

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>) 


2750
2751
2752
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2750

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2757

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