Class: OCI::Database::Models::CreateDbHomeBase

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/create_db_home_base.rb

Overview

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

Constant Summary collapse

SOURCE_ENUM = 
[
  SOURCE_NONE = 'NONE'.freeze,
  SOURCE_DB_BACKUP = 'DB_BACKUP'.freeze,
  SOURCE_DATABASE = 'DATABASE'.freeze,
  SOURCE_VM_CLUSTER_BACKUP = 'VM_CLUSTER_BACKUP'.freeze,
  SOURCE_VM_CLUSTER_NEW = 'VM_CLUSTER_NEW'.freeze,
  SOURCE_VM_CLUSTER_DATABASE = 'VM_CLUSTER_DATABASE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDbHomeBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :kms_key_version_id (String) —

    The value to assign to the #kms_key_version_id property

  • :database_software_image_id (String) —

    The value to assign to the #database_software_image_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

  • :source (String) —

    The value to assign to the #source property

  • :is_desupported_version (BOOLEAN) —

    The value to assign to the #is_desupported_version property

  • :is_unified_auditing_enabled (BOOLEAN) —

    The value to assign to the #is_unified_auditing_enabled property



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
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 137

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?

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

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

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

Instance Attribute Details

#database_software_image_id ⇒ String

The database software image OCID

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 39

def database_software_image_id
  @database_software_image_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.

Returns:

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


53
54
55
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 53

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The user-provided name of the Database Home.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 26

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>) 


47
48
49
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 47

def freeform_tags
  @freeform_tags
end

#is_desupported_version ⇒ BOOLEAN

If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

Returns:

  • (BOOLEAN) 


62
63
64
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 62

def is_desupported_version
  @is_desupported_version
end

#is_unified_auditing_enabled ⇒ BOOLEAN

Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.

Returns:

  • (BOOLEAN) 


66
67
68
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 66

def is_unified_auditing_enabled
  @is_unified_auditing_enabled
end

#kms_key_id ⇒ String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 30

def kms_key_id
  @kms_key_id
end

#kms_key_version_id ⇒ 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. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 35

def kms_key_version_id
  @kms_key_version_id
end

#source ⇒ String

The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 58

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 69

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',
    'is_unified_auditing_enabled': :'isUnifiedAuditingEnabled'
    # 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.



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 107

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::CreateDbHomeWithVmClusterIdFromDatabaseDetails' if type == 'VM_CLUSTER_DATABASE'
  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

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 86

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',
    'is_unified_auditing_enabled': :'BOOLEAN'
    # 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



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

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 &&
    is_unified_auditing_enabled == other.is_unified_auditing_enabled
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



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

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


230
231
232
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 239

def hash
  [display_name, kms_key_id, kms_key_version_id, database_software_image_id, freeform_tags, defined_tags, source, is_desupported_version, is_unified_auditing_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 283

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



277
278
279
 
# File 'lib/oci/database/models/create_db_home_base.rb', line 277

def to_s
  to_hash.to_s
end