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.



2212
2213
2214
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2212

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) 


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

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


2177
2178
2179
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2177

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) 


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

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



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

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


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

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:



2200
2201
2202
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2200

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2205
2206
2207
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2205

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


2210
2211
2212
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2210

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2217

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