Class: OCI::GoldenGate::Models::MappingRule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/mapping_rule.rb

Overview

Mapping rule for source and target schemas for the pipeline data replication. For example: "INCLUDE, source: HR., target: HR." for rule "Include HR.*" which will include all the tables under HR schema.

Constant Summary collapse

MAPPING_TYPE_ENUM =
[
  MAPPING_TYPE_INCLUDE = 'INCLUDE'.freeze,
  MAPPING_TYPE_EXCLUDE = 'EXCLUDE'.freeze,
  MAPPING_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 = {}) ⇒ MappingRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :mapping_type (String)

    The value to assign to the #mapping_type property

  • :source (String)

    The value to assign to the #source property

  • :target (String)

    The value to assign to the #target property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 67

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

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

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

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

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

Instance Attribute Details

#mapping_typeString

[Required] Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.

Returns:

  • (String)


24
25
26
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 24

def mapping_type
  @mapping_type
end

#sourceString

[Required] The source schema/table combination for replication to target.

Returns:

  • (String)


29
30
31
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 29

def source
  @source
end

#targetString

The target schema/table combination for replication from the source.

Returns:

  • (String)


34
35
36
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 34

def target
  @target
end

Class Method Details

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'mapping_type': :'mappingType',
    'source': :'source',
    'target': :'target'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



48
49
50
51
52
53
54
55
56
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'mapping_type': :'String',
    'source': :'String',
    'target': :'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



104
105
106
107
108
109
110
111
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 104

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

  self.class == other.class &&
    mapping_type == other.mapping_type &&
    source == other.source &&
    target == other.target
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 136

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


116
117
118
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 116

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



125
126
127
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 125

def hash
  [mapping_type, source, target].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 169

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



163
164
165
# File 'lib/oci/golden_gate/models/mapping_rule.rb', line 163

def to_s
  to_hash.to_s
end