class OCI::Database::Models::CreateDbHomeBase
Details for creating a Database
Home.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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
Constants
- SOURCE_ENUM
Attributes
The database software image [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) @return [String]
The user-provided name of the Database
Home. @return [String]
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. @return [String]
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
@return [String]
The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/database/models/create_db_home_base.rb, line 63 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'kms_key_id': :'kmsKeyId', 'kms_key_version_id': :'kmsKeyVersionId', 'database_software_image_id': :'databaseSoftwareImageId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'source': :'source', 'is_desupported_version': :'isDesupportedVersion' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/database/models/create_db_home_base.rb, line 99 def self.get_subtype(object_hash) type = object_hash[:'source'] # rubocop:disable Style/SymbolLiteral return 'OCI::Database::Models::CreateDbHomeWithDbSystemIdFromDatabaseDetails' if type == 'DATABASE' return 'OCI::Database::Models::CreateDbHomeWithDbSystemIdFromBackupDetails' if type == 'DB_BACKUP' return 'OCI::Database::Models::CreateDbHomeWithVmClusterIdFromBackupDetails' if type == 'VM_CLUSTER_BACKUP' return 'OCI::Database::Models::CreateDbHomeWithDbSystemIdDetails' if type == 'NONE' return 'OCI::Database::Models::CreateDbHomeWithVmClusterIdDetails' if type == 'VM_CLUSTER_NEW' # TODO: Log a warning when the subtype is not found. 'OCI::Database::Models::CreateDbHomeBase' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :kms_key_id The value to assign to the {#kms_key_id} property @option attributes [String] :kms_key_version_id The value to assign to the {#kms_key_version_id} property @option attributes [String] :database_software_image_id The value to assign to the {#database_software_image_id} 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 [String] :source The value to assign to the {#source} property @option attributes [BOOLEAN] :is_desupported_version The value to assign to the {#is_desupported_version} property
# File lib/oci/database/models/create_db_home_base.rb, line 127 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.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.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId'] raise 'You cannot provide both :kmsKeyId and :kms_key_id' if attributes.key?(:'kmsKeyId') && attributes.key?(:'kms_key_id') self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'kms_key_id'] self.kms_key_version_id = attributes[:'kmsKeyVersionId'] if attributes[:'kmsKeyVersionId'] raise 'You cannot provide both :kmsKeyVersionId and :kms_key_version_id' if attributes.key?(:'kmsKeyVersionId') && attributes.key?(:'kms_key_version_id') self.kms_key_version_id = attributes[:'kms_key_version_id'] if attributes[:'kms_key_version_id'] self.database_software_image_id = attributes[:'databaseSoftwareImageId'] if attributes[:'databaseSoftwareImageId'] raise 'You cannot provide both :databaseSoftwareImageId and :database_software_image_id' if attributes.key?(:'databaseSoftwareImageId') && attributes.key?(:'database_software_image_id') self.database_software_image_id = attributes[:'database_software_image_id'] if attributes[:'database_software_image_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'] self.source = attributes[:'source'] if attributes[:'source'] self.source = "NONE" if source.nil? && !attributes.key?(:'source') # rubocop:disable Style/StringLiterals self.is_desupported_version = attributes[:'isDesupportedVersion'] unless attributes[:'isDesupportedVersion'].nil? raise 'You cannot provide both :isDesupportedVersion and :is_desupported_version' if attributes.key?(:'isDesupportedVersion') && attributes.key?(:'is_desupported_version') self.is_desupported_version = attributes[:'is_desupported_version'] unless attributes[:'is_desupported_version'].nil? end
Attribute type mapping.
# File lib/oci/database/models/create_db_home_base.rb, line 79 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'kms_key_id': :'String', 'kms_key_version_id': :'String', 'database_software_image_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'source': :'String', 'is_desupported_version': :'BOOLEAN' # 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/models/create_db_home_base.rb, line 194 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && kms_key_id == other.kms_key_id && kms_key_version_id == other.kms_key_version_id && database_software_image_id == other.database_software_image_id && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && source == other.source && is_desupported_version == other.is_desupported_version 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/models/create_db_home_base.rb, line 231 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/models/create_db_home_base.rb, line 211 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/database/models/create_db_home_base.rb, line 220 def hash [display_name, kms_key_id, kms_key_version_id, database_software_image_id, freeform_tags, defined_tags, source, is_desupported_version].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] source Object
to be assigned
# File lib/oci/database/models/create_db_home_base.rb, line 183 def source=(source) raise "Invalid value for 'source': this must be one of the values in SOURCE_ENUM." if source && !SOURCE_ENUM.include?(source) @source = source end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/database/models/create_db_home_base.rb, line 264 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/models/create_db_home_base.rb, line 258 def to_s to_hash.to_s 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/models/create_db_home_base.rb, line 281 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