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.



2957
2958
2959
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2957

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) 


2911
2912
2913
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2911

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


2916
2917
2918
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2916

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


2922
2923
2924
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2922

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) 


2928
2929
2930
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2928

def format
  @format
end

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

JsonSchema representation of schema metadata Corresponds to the JSON property items

Returns:



2933
2934
2935
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2933

def items
  @items
end

#jdbc_type ⇒ String

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

Returns:

  • (String) 


2938
2939
2940
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2938

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:



2945
2946
2947
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2945

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2950
2951
2952
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2950

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


2955
2956
2957
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2955

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2962

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