Class: Google::Apis::ConnectorsV1::JsonSchema
- Inherits:
-
Object
- Object
- Google::Apis::ConnectorsV1::JsonSchema
- 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
-
#default ⇒ Object
The default value of the field or object described by this schema.
-
#description ⇒ String
A description of this schema.
-
#enum ⇒ Array<Object>
Possible values for an enumeration.
-
#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. -
#items ⇒ Google::Apis::ConnectorsV1::JsonSchema
JsonSchema representation of schema metadata Corresponds to the JSON property
items. -
#jdbc_type ⇒ String
JDBC datatype of the field.
-
#properties ⇒ Hash<String,Google::Apis::ConnectorsV1::JsonSchema>
The child schemas, applicable only if this is of type
object. -
#required ⇒ Array<String>
Whether this property is required.
-
#type ⇒ Array<String>
JSON Schema Validation: A Vocabulary for Structural Validation of JSON Corresponds to the JSON property
type.
Instance Method Summary collapse
-
#initialize(**args) ⇒ JsonSchema
constructor
A new instance of JsonSchema.
-
#update!(**args) ⇒ Object
Update properties of this object.
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
#default ⇒ Object
The default value of the field or object described by this schema.
Corresponds to the JSON property default
2139 2140 2141 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2139 def default @default end |
#description ⇒ String
A description of this schema.
Corresponds to the JSON property description
2144 2145 2146 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2144 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
2150 2151 2152 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2150 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
2156 2157 2158 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2156 def format @format end |
#items ⇒ Google::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_type ⇒ String
JDBC datatype of the field.
Corresponds to the JSON property jdbcType
2166 2167 2168 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2166 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
2173 2174 2175 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2173 def properties @properties end |
#required ⇒ Array<String>
Whether this property is required.
Corresponds to the JSON property required
2178 2179 2180 |
# File 'lib/google/apis/connectors_v1/classes.rb', line 2178 def required @required end |
#type ⇒ Array<String>
JSON Schema Validation: A Vocabulary for Structural Validation of JSON
Corresponds to the JSON property type
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 |