Class: OCI::GoldenGate::Models::InitialDataLoad

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

Overview

Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.

Constant Summary collapse

IS_INITIAL_LOAD_ENUM =
[
  IS_INITIAL_LOAD_ENABLED = 'ENABLED'.freeze,
  IS_INITIAL_LOAD_DISABLED = 'DISABLED'.freeze,
  IS_INITIAL_LOAD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ACTION_ON_EXISTING_TABLE_ENUM =
[
  ACTION_ON_EXISTING_TABLE_TRUNCATE = 'TRUNCATE'.freeze,
  ACTION_ON_EXISTING_TABLE_REPLACE = 'REPLACE'.freeze,
  ACTION_ON_EXISTING_TABLE_APPEND = 'APPEND'.freeze,
  ACTION_ON_EXISTING_TABLE_SKIP = 'SKIP'.freeze,
  ACTION_ON_EXISTING_TABLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InitialDataLoad

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 65

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.is_initial_load = attributes[:'isInitialLoad'] if attributes[:'isInitialLoad']
  self.is_initial_load = "ENABLED" if is_initial_load.nil? && !attributes.key?(:'isInitialLoad') # rubocop:disable Style/StringLiterals

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

  self.is_initial_load = attributes[:'is_initial_load'] if attributes[:'is_initial_load']
  self.is_initial_load = "ENABLED" if is_initial_load.nil? && !attributes.key?(:'isInitialLoad') && !attributes.key?(:'is_initial_load') # rubocop:disable Style/StringLiterals

  self.action_on_existing_table = attributes[:'actionOnExistingTable'] if attributes[:'actionOnExistingTable']
  self.action_on_existing_table = "REPLACE" if action_on_existing_table.nil? && !attributes.key?(:'actionOnExistingTable') # rubocop:disable Style/StringLiterals

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

  self.action_on_existing_table = attributes[:'action_on_existing_table'] if attributes[:'action_on_existing_table']
  self.action_on_existing_table = "REPLACE" if action_on_existing_table.nil? && !attributes.key?(:'actionOnExistingTable') && !attributes.key?(:'action_on_existing_table') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#action_on_existing_tableString

Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.

Returns:

  • (String)


35
36
37
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 35

def action_on_existing_table
  @action_on_existing_table
end

#is_initial_loadString

[Required] If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.

Returns:

  • (String)


30
31
32
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 30

def is_initial_load
  @is_initial_load
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_initial_load': :'isInitialLoad',
    'action_on_existing_table': :'actionOnExistingTable'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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



121
122
123
124
125
126
127
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 121

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

  self.class == other.class &&
    is_initial_load == other.is_initial_load &&
    action_on_existing_table == other.action_on_existing_table
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 152

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


132
133
134
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 132

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



141
142
143
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 141

def hash
  [is_initial_load, action_on_existing_table].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 185

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



179
180
181
# File 'lib/oci/golden_gate/models/initial_data_load.rb', line 179

def to_s
  to_hash.to_s
end