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.



2899
2900
2901
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2899

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) 


2853
2854
2855
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2853

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


2858
2859
2860
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2858

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


2864
2865
2866
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2864

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) 


2870
2871
2872
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2870

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



2875
2876
2877
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2875

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


2880
2881
2882
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2880

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:



2887
2888
2889
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2887

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2892
2893
2894
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2892

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


2897
2898
2899
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2897

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2904

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