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.



2805
2806
2807
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2805

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) 


2759
2760
2761
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2759

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


2764
2765
2766
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2764

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


2770
2771
2772
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2770

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) 


2776
2777
2778
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2776

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



2781
2782
2783
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2781

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


2786
2787
2788
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2786

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:



2793
2794
2795
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2793

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2798
2799
2800
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2798

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


2803
2804
2805
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2803

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2810

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