Class: OCI::ApplicationMigration::Models::CreateMigrationDetails

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

Overview

While creating a migration, specify the source and the application that you want migrate. Each migration moves a single application from a specified source to a specified Oracle Cloud Infrastructure tenancy. If required, provide the credentials of the application administrator in the source environment. Application Migration uses this information to access the application, as well as discover application artifacts, such as the complete domain configuration along with data sources and other dependencies.

You must also assign a name and provide a description for the migration. This helps you to identify the appropriate source environment when you have multiple sources defined.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

PRE_CREATED_TARGET_DATABASE_TYPE_ENUM = 
[
  PRE_CREATED_TARGET_DATABASE_TYPE_DATABASE_SYSTEM = 'DATABASE_SYSTEM'.freeze,
  PRE_CREATED_TARGET_DATABASE_TYPE_NOT_SET = 'NOT_SET'.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):



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 146

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

  self.source_id = attributes[:'sourceId'] if attributes[:'sourceId']

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

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

  self.application_name = attributes[:'applicationName'] if attributes[:'applicationName']

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

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

  self.discovery_details = attributes[:'discoveryDetails'] if attributes[:'discoveryDetails']

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

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

  self.pre_created_target_database_type = attributes[:'preCreatedTargetDatabaseType'] if attributes[:'preCreatedTargetDatabaseType']

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

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

  self.is_selective_migration = attributes[:'isSelectiveMigration'] unless attributes[:'isSelectiveMigration'].nil?
  self.is_selective_migration = false if is_selective_migration.nil? && !attributes.key?(:'isSelectiveMigration') # rubocop:disable Style/StringLiterals

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

  self.is_selective_migration = attributes[:'is_selective_migration'] unless attributes[:'is_selective_migration'].nil?
  self.is_selective_migration = false if is_selective_migration.nil? && !attributes.key?(:'isSelectiveMigration') && !attributes.key?(:'is_selective_migration') # rubocop:disable Style/StringLiterals

  self.service_config = attributes[:'serviceConfig'] if attributes[:'serviceConfig']

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

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

  self.application_config = attributes[:'applicationConfig'] if attributes[:'applicationConfig']

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

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

  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

#application_config ⇒ Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>

Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.

Returns:



74
75
76
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 74

def application_config
  @application_config
end

#application_name ⇒ String

[Required] Name of the application that you want to migrate from the source environment.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 45

def application_name
  @application_name
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the source.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 29

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


86
87
88
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 86

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the application that you are migrating.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 37

def description
  @description
end

#discovery_details ⇒ OCI::ApplicationMigration::Models::DiscoveryDetails

This attribute is required.

Returns:



49
50
51
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 49

def discovery_details
  @discovery_details
end

#display_name ⇒ String

User-friendly name of the application. This will be the name of the migrated application in Oracle Cloud Infrastructure.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 33

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: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


80
81
82
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 80

def freeform_tags
  @freeform_tags
end

#is_selective_migration ⇒ BOOLEAN

If set to true, Application Migration migrates the application resources selectively depending on the source.

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 60

def is_selective_migration
  @is_selective_migration
end

#pre_created_target_database_type ⇒ String

The pre-existing database type to be used in this migration. Currently, Application migration only supports Oracle Cloud Infrastructure databases and this option is currently available only for JAVA_CLOUD_SERVICE and WEBLOGIC_CLOUD_SERVICE target instance types.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 55

def pre_created_target_database_type
  @pre_created_target_database_type
end

#service_config ⇒ Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>

Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.

Returns:



67
68
69
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 67

def service_config
  @service_config
end

#source_id ⇒ String

[Required] The OCID of the source.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 41

def source_id
  @source_id
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'source_id': :'sourceId',
    'application_name': :'applicationName',
    'discovery_details': :'discoveryDetails',
    'pre_created_target_database_type': :'preCreatedTargetDatabaseType',
    'is_selective_migration': :'isSelectiveMigration',
    'service_config': :'serviceConfig',
    'application_config': :'applicationConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'source_id': :'String',
    'application_name': :'String',
    'discovery_details': :'OCI::ApplicationMigration::Models::DiscoveryDetails',
    'pre_created_target_database_type': :'String',
    'is_selective_migration': :'BOOLEAN',
    'service_config': :'Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>',
    'application_config': :'Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>',
    '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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 238

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    source_id == other.source_id &&
    application_name == other.application_name &&
    discovery_details == other.discovery_details &&
    pre_created_target_database_type == other.pre_created_target_database_type &&
    is_selective_migration == other.is_selective_migration &&
    service_config == other.service_config &&
    application_config == other.application_config &&
    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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 279

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


259
260
261
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 259

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 268

def hash
  [compartment_id, display_name, description, source_id, application_name, discovery_details, pre_created_target_database_type, is_selective_migration, service_config, application_config, 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



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 312

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



306
307
308
 
# File 'lib/oci/application_migration/models/create_migration_details.rb', line 306

def to_s
  to_hash.to_s
end