class OCI::DatabaseMigration::Models::Migration
Migration
resource
Constants
- LIFECYCLE_DETAILS_ENUM
- LIFECYCLE_STATE_ENUM
- TYPE_ENUM
- WAIT_AFTER_ENUM
Attributes
The OCID of the registered on-premises ODMS Agent. Only valid for Offline Migrations.
@return [String]
[Required] OCID of the compartment
@return [String]
OCID of the Secret in the OCI
vault containing the Migration
credentials. Used to store GoldenGate
administrator user credentials.
@return [String]
@return [OCI::DatabaseMigration::Models::DataTransferMediumDetails]
@return [OCI::DatabaseMigration::Models::DataPumpSettings]
[Required] Migration
Display Name
@return [String]
Database
objects to exclude from migration.
@return [Array<OCI::DatabaseMigration::Models::DatabaseObject>]
OCID of the current ODMS Job in execution for the Migration
, if any.
@return [String]
@return [OCI::DatabaseMigration::Models::GoldenGateDetails]
[Required] The OCID of the resource
@return [String]
Additional status related to the execution and current state of the Migration
.
@return [String]
[Required] The current state of the Migration
resource.
@return [String]
The OCID of the Source Container Database
Connection.
@return [String]
[Required] The OCID of the Source Database
Connection.
@return [String]
[Required] The OCID of the Target Database
Connection.
@return [String]
[Required] The time the Migration
was created. An RFC3339 formatted datetime string.
@return [DateTime]
The time of last Migration
. An RFC3339 formatted datetime string.
@return [DateTime]
The time of the last Migration
details update. An RFC3339 formatted datetime string.
@return [DateTime]
[Required] Migration
type.
@return [String]
@return [OCI::DatabaseMigration::Models::VaultDetails]
Name of a migration phase. The Job will wait after executing this phase until the Resume Job endpoint is called.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/database_migration/models/migration.rb, line 177 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'type': :'type', 'wait_after': :'waitAfter', 'agent_id': :'agentId', 'credentials_secret_id': :'credentialsSecretId', 'source_database_connection_id': :'sourceDatabaseConnectionId', 'source_container_database_connection_id': :'sourceContainerDatabaseConnectionId', 'target_database_connection_id': :'targetDatabaseConnectionId', 'executing_job_id': :'executingJobId', 'data_transfer_medium_details': :'dataTransferMediumDetails', 'datapump_settings': :'datapumpSettings', 'exclude_objects': :'excludeObjects', 'golden_gate_details': :'goldenGateDetails', 'vault_details': :'vaultDetails', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'time_last_migration': :'timeLastMigration', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end
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] :display_name The value to assign to the {#display_name} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :type The value to assign to the {#type} property @option attributes [String] :wait_after The value to assign to the {#wait_after} property @option attributes [String] :agent_id The value to assign to the {#agent_id} property @option attributes [String] :credentials_secret_id The value to assign to the {#credentials_secret_id} property @option attributes [String] :source_database_connection_id The value to assign to the {#source_database_connection_id} property @option attributes [String] :source_container_database_connection_id The value to assign to the {#source_container_database_connection_id} property @option attributes [String] :target_database_connection_id The value to assign to the {#target_database_connection_id} property @option attributes [String] :executing_job_id The value to assign to the {#executing_job_id} property @option attributes [OCI::DatabaseMigration::Models::DataTransferMediumDetails] :data_transfer_medium_details The value to assign to the {#data_transfer_medium_details} property @option attributes [OCI::DatabaseMigration::Models::DataPumpSettings] :datapump_settings The value to assign to the {#datapump_settings} property @option attributes [Array<OCI::DatabaseMigration::Models::DatabaseObject>] :exclude_objects The value to assign to the {#exclude_objects} property @option attributes [OCI::DatabaseMigration::Models::GoldenGateDetails] :golden_gate_details The value to assign to the {#golden_gate_details} property @option attributes [OCI::DatabaseMigration::Models::VaultDetails] :vault_details The value to assign to the {#vault_details} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [DateTime] :time_last_migration The value to assign to the {#time_last_migration} 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 [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 @option attributes [Hash<String, Hash<String, Object>>] :system_tags The value to assign to the {#system_tags} property
# File lib/oci/database_migration/models/migration.rb, line 270 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.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.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.type = attributes[:'type'] if attributes[:'type'] self.wait_after = attributes[:'waitAfter'] if attributes[:'waitAfter'] raise 'You cannot provide both :waitAfter and :wait_after' if attributes.key?(:'waitAfter') && attributes.key?(:'wait_after') self.wait_after = attributes[:'wait_after'] if attributes[:'wait_after'] self.agent_id = attributes[:'agentId'] if attributes[:'agentId'] raise 'You cannot provide both :agentId and :agent_id' if attributes.key?(:'agentId') && attributes.key?(:'agent_id') self.agent_id = attributes[:'agent_id'] if attributes[:'agent_id'] self.credentials_secret_id = attributes[:'credentialsSecretId'] if attributes[:'credentialsSecretId'] raise 'You cannot provide both :credentialsSecretId and :credentials_secret_id' if attributes.key?(:'credentialsSecretId') && attributes.key?(:'credentials_secret_id') self.credentials_secret_id = attributes[:'credentials_secret_id'] if attributes[:'credentials_secret_id'] 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.source_container_database_connection_id = attributes[:'sourceContainerDatabaseConnectionId'] if attributes[:'sourceContainerDatabaseConnectionId'] raise 'You cannot provide both :sourceContainerDatabaseConnectionId and :source_container_database_connection_id' if attributes.key?(:'sourceContainerDatabaseConnectionId') && attributes.key?(:'source_container_database_connection_id') self.source_container_database_connection_id = attributes[:'source_container_database_connection_id'] if attributes[:'source_container_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.executing_job_id = attributes[:'executingJobId'] if attributes[:'executingJobId'] raise 'You cannot provide both :executingJobId and :executing_job_id' if attributes.key?(:'executingJobId') && attributes.key?(:'executing_job_id') self.executing_job_id = attributes[:'executing_job_id'] if attributes[:'executing_job_id'] self.data_transfer_medium_details = attributes[:'dataTransferMediumDetails'] if attributes[:'dataTransferMediumDetails'] raise 'You cannot provide both :dataTransferMediumDetails and :data_transfer_medium_details' if attributes.key?(:'dataTransferMediumDetails') && attributes.key?(:'data_transfer_medium_details') self.data_transfer_medium_details = attributes[:'data_transfer_medium_details'] if attributes[:'data_transfer_medium_details'] self.datapump_settings = attributes[:'datapumpSettings'] if attributes[:'datapumpSettings'] raise 'You cannot provide both :datapumpSettings and :datapump_settings' if attributes.key?(:'datapumpSettings') && attributes.key?(:'datapump_settings') self.datapump_settings = attributes[:'datapump_settings'] if attributes[:'datapump_settings'] self.exclude_objects = attributes[:'excludeObjects'] if attributes[:'excludeObjects'] raise 'You cannot provide both :excludeObjects and :exclude_objects' if attributes.key?(:'excludeObjects') && attributes.key?(:'exclude_objects') self.exclude_objects = attributes[:'exclude_objects'] if attributes[:'exclude_objects'] self.golden_gate_details = attributes[:'goldenGateDetails'] if attributes[:'goldenGateDetails'] raise 'You cannot provide both :goldenGateDetails and :golden_gate_details' if attributes.key?(:'goldenGateDetails') && attributes.key?(:'golden_gate_details') self.golden_gate_details = attributes[:'golden_gate_details'] if attributes[:'golden_gate_details'] self.vault_details = attributes[:'vaultDetails'] if attributes[:'vaultDetails'] raise 'You cannot provide both :vaultDetails and :vault_details' if attributes.key?(:'vaultDetails') && attributes.key?(:'vault_details') self.vault_details = attributes[:'vault_details'] if attributes[:'vault_details'] 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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.time_last_migration = attributes[:'timeLastMigration'] if attributes[:'timeLastMigration'] raise 'You cannot provide both :timeLastMigration and :time_last_migration' if attributes.key?(:'timeLastMigration') && attributes.key?(:'time_last_migration') self.time_last_migration = attributes[:'time_last_migration'] if attributes[:'time_last_migration'] 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.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'] self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags'] end
Attribute type mapping.
# File lib/oci/database_migration/models/migration.rb, line 209 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'type': :'String', 'wait_after': :'String', 'agent_id': :'String', 'credentials_secret_id': :'String', 'source_database_connection_id': :'String', 'source_container_database_connection_id': :'String', 'target_database_connection_id': :'String', 'executing_job_id': :'String', 'data_transfer_medium_details': :'OCI::DatabaseMigration::Models::DataTransferMediumDetails', 'datapump_settings': :'OCI::DatabaseMigration::Models::DataPumpSettings', 'exclude_objects': :'Array<OCI::DatabaseMigration::Models::DatabaseObject>', 'golden_gate_details': :'OCI::DatabaseMigration::Models::GoldenGateDetails', 'vault_details': :'OCI::DatabaseMigration::Models::VaultDetails', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'time_last_migration': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/database_migration/models/migration.rb, line 472 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && type == other.type && wait_after == other.wait_after && agent_id == other.agent_id && credentials_secret_id == other.credentials_secret_id && source_database_connection_id == other.source_database_connection_id && source_container_database_connection_id == other.source_container_database_connection_id && target_database_connection_id == other.target_database_connection_id && executing_job_id == other.executing_job_id && data_transfer_medium_details == other.data_transfer_medium_details && datapump_settings == other.datapump_settings && exclude_objects == other.exclude_objects && golden_gate_details == other.golden_gate_details && vault_details == other.vault_details && time_created == other.time_created && time_updated == other.time_updated && time_last_migration == other.time_last_migration && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && system_tags == other.system_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/database_migration/models/migration.rb, line 525 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/database_migration/models/migration.rb, line 505 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/database_migration/models/migration.rb, line 514 def hash [id, display_name, compartment_id, type, wait_after, agent_id, credentials_secret_id, source_database_connection_id, source_container_database_connection_id, target_database_connection_id, executing_job_id, data_transfer_medium_details, datapump_settings, exclude_objects, golden_gate_details, vault_details, time_created, time_updated, time_last_migration, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_details
Object
to be assigned
# File lib/oci/database_migration/models/migration.rb, line 456 def lifecycle_details=(lifecycle_details) # rubocop:disable Style/ConditionalAssignment if lifecycle_details && !LIFECYCLE_DETAILS_ENUM.include?(lifecycle_details) OCI.logger.debug("Unknown value for 'lifecycle_details' [" + lifecycle_details + "]. Mapping to 'LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_details = LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE else @lifecycle_details = lifecycle_details end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/database_migration/models/migration.rb, line 443 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/database_migration/models/migration.rb, line 558 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/database_migration/models/migration.rb, line 552 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object
to be assigned
# File lib/oci/database_migration/models/migration.rb, line 417 def type=(type) # rubocop:disable Style/ConditionalAssignment if type && !TYPE_ENUM.include?(type) OCI.logger.debug("Unknown value for 'type' [" + type + "]. Mapping to 'TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @type = TYPE_UNKNOWN_ENUM_VALUE else @type = type end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] wait_after
Object
to be assigned
# File lib/oci/database_migration/models/migration.rb, line 430 def wait_after=(wait_after) # rubocop:disable Style/ConditionalAssignment if wait_after && !WAIT_AFTER_ENUM.include?(wait_after) OCI.logger.debug("Unknown value for 'wait_after' [" + wait_after + "]. Mapping to 'WAIT_AFTER_UNKNOWN_ENUM_VALUE'") if OCI.logger @wait_after = WAIT_AFTER_UNKNOWN_ENUM_VALUE else @wait_after = wait_after end # rubocop:enable Style/ConditionalAssignment end
Private Instance Methods
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/database_migration/models/migration.rb, line 575 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