Class: OCI::DataIntegration::Models::PivotField

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

Overview

The type representing the pivot field. Pivot fields have an expression to define a macro and a pattern to generate the column name

Constant Summary

Constants inherited from TypedObject

TypedObject::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from TypedObject

#config_values, #description, #key, #model_type, #model_version, #name, #object_status, #parent_ref

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TypedObject

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PivotField

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 82

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'PIVOT_FIELD'

  super(attributes)

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

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

  self.use_type = attributes[:'useType'] if attributes[:'useType']

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

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

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

  self.column_name_pattern = attributes[:'columnNamePattern'] if attributes[:'columnNamePattern']

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

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

Instance Attribute Details

#column_name_pattern ⇒ String

column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 23

def column_name_pattern
  @column_name_pattern
end

#expr ⇒ OCI::DataIntegration::Models::Expression

Returns:



13
14
15
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 13

def expr
  @expr
end

#type ⇒ OCI::DataIntegration::Models::BaseType

Returns:



19
20
21
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 19

def type
  @type
end

#use_type ⇒ OCI::DataIntegration::Models::ConfiguredType

Returns:



16
17
18
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 16

def use_type
  @use_type
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'config_values': :'configValues',
    'object_status': :'objectStatus',
    'name': :'name',
    'description': :'description',
    'expr': :'expr',
    'use_type': :'useType',
    'type': :'type',
    'column_name_pattern': :'columnNamePattern'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'object_status': :'Integer',
    'name': :'String',
    'description': :'String',
    'expr': :'OCI::DataIntegration::Models::Expression',
    'use_type': :'OCI::DataIntegration::Models::ConfiguredType',
    'type': :'OCI::DataIntegration::Models::BaseType',
    'column_name_pattern': :'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
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 116

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    config_values == other.config_values &&
    object_status == other.object_status &&
    name == other.name &&
    description == other.description &&
    expr == other.expr &&
    use_type == other.use_type &&
    type == other.type &&
    column_name_pattern == other.column_name_pattern
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 157

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


137
138
139
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 146

def hash
  [model_type, key, model_version, parent_ref, config_values, object_status, name, description, expr, use_type, type, column_name_pattern].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 190

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



184
185
186
 
# File 'lib/oci/data_integration/models/pivot_field.rb', line 184

def to_s
  to_hash.to_s
end