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.



871
872
873
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 871

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


820
821
822
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 820

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) 


825
826
827
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 825

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


830
831
832
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 830

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


836
837
838
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 836

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) 


842
843
844
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 842

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



847
848
849
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 847

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


852
853
854
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 852

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:



859
860
861
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 859

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


864
865
866
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 864

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


869
870
871
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 869

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/google/apis/connectors_v2/classes.rb', line 876

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