Class: OCI::DatabaseMigration::Models::CreateMigrationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/create_migration_details.rb

Overview

Common Migration details. 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

DATABASE_COMBINATION_ENUM = 
[
  DATABASE_COMBINATION_MYSQL = 'MYSQL'.freeze,
  DATABASE_COMBINATION_ORACLE = 'ORACLE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_ONLINE = 'ONLINE'.freeze,
  TYPE_OFFLINE = 'OFFLINE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMigrationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :database_combination (String) —

    The value to assign to the #database_combination property

  • :type (String) —

    The value to assign to the #type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :source_database_connection_id (String) —

    The value to assign to the #source_database_connection_id property

  • :target_database_connection_id (String) —

    The value to assign to the #target_database_connection_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 135

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.database_combination = attributes[:'databaseCombination'] if attributes[:'databaseCombination']

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.source_database_connection_id = attributes[:'sourceDatabaseConnectionId'] if attributes[:'sourceDatabaseConnectionId']

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

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

  self.target_database_connection_id = attributes[:'targetDatabaseConnectionId'] if attributes[:'targetDatabaseConnectionId']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 30

def compartment_id
  @compartment_id
end

#database_combination ⇒ String

[Required] The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 36

def database_combination
  @database_combination
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


68
69
70
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 68

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 26

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 48

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: "Finance"

Returns:

  • (Hash<String, String>) 


62
63
64
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 62

def freeform_tags
  @freeform_tags
end

#source_database_connection_id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 52

def source_database_connection_id
  @source_database_connection_id
end

#target_database_connection_id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 56

def target_database_connection_id
  @target_database_connection_id
end

#type ⇒ String

[Required] The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 42

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'compartment_id': :'compartmentId',
    'database_combination': :'databaseCombination',
    'type': :'type',
    'display_name': :'displayName',
    'source_database_connection_id': :'sourceDatabaseConnectionId',
    'target_database_connection_id': :'targetDatabaseConnectionId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 109

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

  return 'OCI::DatabaseMigration::Models::CreateMySqlMigrationDetails' if type == 'MYSQL'
  return 'OCI::DatabaseMigration::Models::CreateOracleMigrationDetails' if type == 'ORACLE'

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

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'compartment_id': :'String',
    'database_combination': :'String',
    'type': :'String',
    'display_name': :'String',
    'source_database_connection_id': :'String',
    'target_database_connection_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 211

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

  self.class == other.class &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    database_combination == other.database_combination &&
    type == other.type &&
    display_name == other.display_name &&
    source_database_connection_id == other.source_database_connection_id &&
    target_database_connection_id == other.target_database_connection_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 249

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


229
230
231
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 229

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 238

def hash
  [description, compartment_id, database_combination, type, display_name, source_database_connection_id, target_database_connection_id, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 282

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



276
277
278
 
# File 'lib/oci/database_migration/models/create_migration_details.rb', line 276

def to_s
  to_hash.to_s
end