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.



2185
2186
2187
# File 'lib/google/apis/connectors_v1/classes.rb', line 2185

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#defaultObject

The default value of the field or object described by this schema. Corresponds to the JSON property default

Returns:

  • (Object)


2139
2140
2141
# File 'lib/google/apis/connectors_v1/classes.rb', line 2139

def default
  @default
end

#descriptionString

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

Returns:

  • (String)


2144
2145
2146
# File 'lib/google/apis/connectors_v1/classes.rb', line 2144

def description
  @description
end

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


2150
2151
2152
# File 'lib/google/apis/connectors_v1/classes.rb', line 2150

def enum
  @enum
end

#formatString

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)


2156
2157
2158
# File 'lib/google/apis/connectors_v1/classes.rb', line 2156

def format
  @format
end

#itemsGoogle::Apis::ConnectorsV1::JsonSchema

JsonSchema representation of schema metadata Corresponds to the JSON property items



2161
2162
2163
# File 'lib/google/apis/connectors_v1/classes.rb', line 2161

def items
  @items
end

#jdbc_typeString

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

Returns:

  • (String)


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

def jdbc_type
  @jdbc_type
end

#propertiesHash<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:



2173
2174
2175
# File 'lib/google/apis/connectors_v1/classes.rb', line 2173

def properties
  @properties
end

#requiredArray<String>

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

Returns:

  • (Array<String>)


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

def required
  @required
end

#typeArray<String>

JSON Schema Validation: A Vocabulary for Structural Validation of JSON Corresponds to the JSON property type

Returns:

  • (Array<String>)


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

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
# File 'lib/google/apis/connectors_v1/classes.rb', line 2190

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