Class: OCI::DataIntegration::Models::FieldMap

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/field_map.rb

Overview

A field map is a way to map a source row shape to a target row shape that may be different. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_DIRECT_NAMED_FIELD_MAP = 'DIRECT_NAMED_FIELD_MAP'.freeze,
  MODEL_TYPE_COMPOSITE_FIELD_MAP = 'COMPOSITE_FIELD_MAP'.freeze,
  MODEL_TYPE_DIRECT_FIELD_MAP = 'DIRECT_FIELD_MAP'.freeze,
  MODEL_TYPE_RULE_BASED_FIELD_MAP = 'RULE_BASED_FIELD_MAP'.freeze,
  MODEL_TYPE_CONDITIONAL_COMPOSITE_FIELD_MAP = 'CONDITIONAL_COMPOSITE_FIELD_MAP'.freeze,
  MODEL_TYPE_NAMED_ENTITY_MAP = 'NAMED_ENTITY_MAP'.freeze,
  MODEL_TYPE_RULE_BASED_ENTITY_MAP = 'RULE_BASED_ENTITY_MAP'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FieldMap

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :model_type (String) —

    The value to assign to the #model_type property

  • :description (String) —

    The value to assign to the #description property



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/data_integration/models/field_map.rb', line 81

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.model_type = attributes[:'modelType'] if attributes[:'modelType']

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

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

  self.description = attributes[:'description'] if attributes[:'description']
end

Instance Attribute Details

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_integration/models/field_map.rb', line 30

def description
  @description
end

#model_type ⇒ String

[Required] The model type for the field map.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_integration/models/field_map.rb', line 26

def model_type
  @model_type
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
 
# File 'lib/oci/data_integration/models/field_map.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/data_integration/models/field_map.rb', line 57

def self.get_subtype(object_hash)
  type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DataIntegration::Models::RuleBasedFieldMap' if type == 'RULE_BASED_FIELD_MAP'
  return 'OCI::DataIntegration::Models::RuleBasedEntityMap' if type == 'RULE_BASED_ENTITY_MAP'
  return 'OCI::DataIntegration::Models::NamedEntityMap' if type == 'NAMED_ENTITY_MAP'
  return 'OCI::DataIntegration::Models::DirectFieldMap' if type == 'DIRECT_FIELD_MAP'
  return 'OCI::DataIntegration::Models::CompositeFieldMap' if type == 'COMPOSITE_FIELD_MAP'
  return 'OCI::DataIntegration::Models::ConditionalCompositeFieldMap' if type == 'CONDITIONAL_COMPOSITE_FIELD_MAP'
  return 'OCI::DataIntegration::Models::DirectNamedFieldMap' if type == 'DIRECT_NAMED_FIELD_MAP'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DataIntegration::Models::FieldMap'
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
 
# File 'lib/oci/data_integration/models/field_map.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'description': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



116
117
118
119
120
121
122
 
# File 'lib/oci/data_integration/models/field_map.rb', line 116

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    model_type == other.model_type &&
    description == other.description
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/data_integration/models/field_map.rb', line 147

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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


127
128
129
 
# File 'lib/oci/data_integration/models/field_map.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/oci/data_integration/models/field_map.rb', line 136

def hash
  [model_type, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/data_integration/models/field_map.rb', line 180

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



174
175
176
 
# File 'lib/oci/data_integration/models/field_map.rb', line 174

def to_s
  to_hash.to_s
end