class OCI::DataIntegration::Models::StructuredType

A `StructuredType` object represents a data type that exists in a physical data asset object such as a table column, but is more complex. For example, an Oracle database `OBJECT` type. It can be composed of multiple `DataType` objects.

Constants

DT_TYPE_ENUM

Attributes

config_definition[RW]

@return [OCI::DataIntegration::Models::ConfigDefinition]

dt_type[R]

The data type. @return [String]

schema[RW]

@return [OCI::DataIntegration::Models::BaseType]

type_system_name[RW]

The data type system name. @return [String]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/data_integration/models/structured_type.rb, line 30
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'schema': :'schema',
    'dt_type': :'dtType',
    'type_system_name': :'typeSystemName',
    'config_definition': :'configDefinition'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [OCI::DataIntegration::Models::BaseType] :schema The value to assign to the {#schema} property @option attributes [String] :dt_type The value to assign to the {#dt_type} property @option attributes [String] :type_system_name The value to assign to the {#type_system_name} property @option attributes [OCI::DataIntegration::Models::ConfigDefinition] :config_definition The value to assign to the {#config_definition} property

# File lib/oci/data_integration/models/structured_type.rb, line 63
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.schema = attributes[:'schema'] if attributes[:'schema']

  self.dt_type = attributes[:'dtType'] if attributes[:'dtType']

  raise 'You cannot provide both :dtType and :dt_type' if attributes.key?(:'dtType') && attributes.key?(:'dt_type')

  self.dt_type = attributes[:'dt_type'] if attributes[:'dt_type']

  self.type_system_name = attributes[:'typeSystemName'] if attributes[:'typeSystemName']

  raise 'You cannot provide both :typeSystemName and :type_system_name' if attributes.key?(:'typeSystemName') && attributes.key?(:'type_system_name')

  self.type_system_name = attributes[:'type_system_name'] if attributes[:'type_system_name']

  self.config_definition = attributes[:'configDefinition'] if attributes[:'configDefinition']

  raise 'You cannot provide both :configDefinition and :config_definition' if attributes.key?(:'configDefinition') && attributes.key?(:'config_definition')

  self.config_definition = attributes[:'config_definition'] if attributes[:'config_definition']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_integration/models/structured_type.rb, line 42
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'schema': :'OCI::DataIntegration::Models::BaseType',
    'dt_type': :'String',
    'type_system_name': :'String',
    'config_definition': :'OCI::DataIntegration::Models::ConfigDefinition'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/structured_type.rb, line 105
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    schema == other.schema &&
    dt_type == other.dt_type &&
    type_system_name == other.type_system_name &&
    config_definition == other.config_definition
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_integration/models/structured_type.rb, line 138
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
dt_type=(dt_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] dt_type Object to be assigned

# File lib/oci/data_integration/models/structured_type.rb, line 94
def dt_type=(dt_type)
  raise "Invalid value for 'dt_type': this must be one of the values in DT_TYPE_ENUM." if dt_type && !DT_TYPE_ENUM.include?(dt_type)

  @dt_type = dt_type
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/structured_type.rb, line 118
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_integration/models/structured_type.rb, line 127
def hash
  [schema, dt_type, type_system_name, config_definition].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_integration/models/structured_type.rb, line 171
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_integration/models/structured_type.rb, line 165
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/data_integration/models/structured_type.rb, line 188
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end