class OCI::ApplicationMigration::Models::Migration

The properties that define a migration. A migration represents the end-to-end workflow of moving an application from a source environment to Oracle Cloud Infrastructure. Each migration moves a single application to Oracle Cloud Infrastructure. For more information, see [Manage Migrations](docs.cloud.oracle.com/iaas/application-migration/manage_migrations.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Constants

APPLICATION_TYPE_ENUM
LIFECYCLE_STATE_ENUM
MIGRATION_STATE_ENUM
PRE_CREATED_TARGET_DATABASE_TYPE_ENUM

Attributes

application_config[RW]

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.

@return [Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>]

application_name[RW]

Name of the application which is being migrated. This is the name of the application in the source environment. @return [String]

application_type[R]

The type of application being migrated. @return [String]

compartment_id[RW]

The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the migration.

@return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`

@return [Hash<String, Hash<String, Object>>]

description[RW]

Description of the migration. @return [String]

display_name[RW]

User-friendly name of the migration. @return [String]

freeform_tags[RW]

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`

@return [Hash<String, String>]

id[RW]

The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the migration. @return [String]

is_selective_migration[RW]

If set to `true`, Application Migration migrates only the application resources that you specify. If set to `false`, Application Migration migrates the entire application. When you migrate the entire application, all the application resources are migrated to the target environment. You can selectively migrate resources only for the Oracle Integration Cloud and Oracle Integration Cloud Service applications.

@return [BOOLEAN]

lifecycle_details[RW]

Details about the current lifecycle state of the migration. @return [String]

lifecycle_state[R]

The current state of the migration. @return [String]

migration_state[R]

The current state of the overall migration process. @return [String]

pre_created_target_database_type[R]

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.

@return [String]

service_config[RW]

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.

@return [Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>]

source_id[RW]

The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source with which this migration is associated. @return [String]

time_created[RW]

The date and time at which the migration was created, in the format defined by RFC3339. @return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/application_migration/models/migration.rb, line 139
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'source_id': :'sourceId',
    'application_name': :'applicationName',
    'application_type': :'applicationType',
    'pre_created_target_database_type': :'preCreatedTargetDatabaseType',
    'is_selective_migration': :'isSelectiveMigration',
    'service_config': :'serviceConfig',
    'application_config': :'applicationConfig',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'migration_state': :'migrationState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :source_id The value to assign to the {#source_id} property @option attributes [String] :application_name The value to assign to the {#application_name} property @option attributes [String] :application_type The value to assign to the {#application_type} property @option attributes [String] :pre_created_target_database_type The value to assign to the {#pre_created_target_database_type} property @option attributes [BOOLEAN] :is_selective_migration The value to assign to the {#is_selective_migration} property @option attributes [Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>] :service_config The value to assign to the {#service_config} property @option attributes [Hash<String, OCI::ApplicationMigration::Models::ConfigurationField>] :application_config The value to assign to the {#application_config} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecycle_details The value to assign to the {#lifecycle_details} property @option attributes [String] :migration_state The value to assign to the {#migration_state} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property

# File lib/oci/application_migration/models/migration.rb, line 211
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.id = attributes[:'id'] if attributes[:'id']

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

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

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

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

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

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

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

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.migration_state = attributes[:'migrationState'] if attributes[:'migrationState']

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

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

  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/application_migration/models/migration.rb, line 164
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'source_id': :'String',
    'application_name': :'String',
    'application_type': :'String',
    '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>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'migration_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/application_migration/models/migration.rb, line 373
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    source_id == other.source_id &&
    application_name == other.application_name &&
    application_type == other.application_type &&
    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 &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    migration_state == other.migration_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end
application_type=(application_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] application_type Object to be assigned

# File lib/oci/application_migration/models/migration.rb, line 318
def application_type=(application_type)
  # rubocop:disable Style/ConditionalAssignment
  if application_type && !APPLICATION_TYPE_ENUM.include?(application_type)
    OCI.logger.debug("Unknown value for 'application_type' [" + application_type + "]. Mapping to 'APPLICATION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @application_type = APPLICATION_TYPE_UNKNOWN_ENUM_VALUE
  else
    @application_type = application_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/application_migration/models/migration.rb, line 419
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/application_migration/models/migration.rb, line 399
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/application_migration/models/migration.rb, line 408
def hash
  [id, compartment_id, display_name, description, time_created, source_id, application_name, application_type, pre_created_target_database_type, is_selective_migration, service_config, application_config, lifecycle_state, lifecycle_details, migration_state, freeform_tags, defined_tags].hash
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/application_migration/models/migration.rb, line 344
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
migration_state=(migration_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] migration_state Object to be assigned

# File lib/oci/application_migration/models/migration.rb, line 357
def migration_state=(migration_state)
  # rubocop:disable Style/ConditionalAssignment
  if migration_state && !MIGRATION_STATE_ENUM.include?(migration_state)
    OCI.logger.debug("Unknown value for 'migration_state' [" + migration_state + "]. Mapping to 'MIGRATION_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @migration_state = MIGRATION_STATE_UNKNOWN_ENUM_VALUE
  else
    @migration_state = migration_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
pre_created_target_database_type=(pre_created_target_database_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] pre_created_target_database_type Object to be assigned

# File lib/oci/application_migration/models/migration.rb, line 331
def pre_created_target_database_type=(pre_created_target_database_type)
  # rubocop:disable Style/ConditionalAssignment
  if pre_created_target_database_type && !PRE_CREATED_TARGET_DATABASE_TYPE_ENUM.include?(pre_created_target_database_type)
    OCI.logger.debug("Unknown value for 'pre_created_target_database_type' [" + pre_created_target_database_type + "]. Mapping to 'PRE_CREATED_TARGET_DATABASE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @pre_created_target_database_type = PRE_CREATED_TARGET_DATABASE_TYPE_UNKNOWN_ENUM_VALUE
  else
    @pre_created_target_database_type = pre_created_target_database_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/application_migration/models/migration.rb, line 452
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/application_migration/models/migration.rb, line 446
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/application_migration/models/migration.rb, line 469
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end