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.



2194
2195
2196
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2194

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) 


2148
2149
2150
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2148

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


2153
2154
2155
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2153

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


2159
2160
2161
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2159

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) 


2165
2166
2167
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2165

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



2170
2171
2172
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2170

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


2175
2176
2177
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2175

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:



2182
2183
2184
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2182

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2187
2188
2189
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2187

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


2192
2193
2194
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2192

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2199

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