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.



4134
4135
4136
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4134

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

Instance Attribute Details

#additional_details ⇒ Hash<String,Object>

Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema Corresponds to the JSON property additionalDetails

Returns:

  • (Hash<String,Object>) 


4083
4084
4085
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4083

def additional_details
  @additional_details
end

#default ⇒ Object

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

Returns:

  • (Object) 


4088
4089
4090
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4088

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


4093
4094
4095
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4093

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


4099
4100
4101
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4099

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) 


4105
4106
4107
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4105

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



4110
4111
4112
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4110

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


4115
4116
4117
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4115

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:



4122
4123
4124
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4122

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


4127
4128
4129
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4127

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


4132
4133
4134
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4132

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4139

def update!(**args)
  @additional_details = args[:additional_details] if args.key?(:additional_details)
  @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