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.



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

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


4036
4037
4038
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4036

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) 


4041
4042
4043
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4041

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


4046
4047
4048
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4046

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


4052
4053
4054
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4052

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) 


4058
4059
4060
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4058

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



4063
4064
4065
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4063

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


4068
4069
4070
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4068

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:



4075
4076
4077
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4075

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


4080
4081
4082
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4080

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


4085
4086
4087
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4085

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4092

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