Class: OCI::Database::Models::DatabaseSoftwareImage

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

Overview

Database software images are created by specifying a patch set, one-off patches and patches for the database home (listed by ls inventory).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IMAGE_TYPE_ENUM = 
[
  IMAGE_TYPE_GRID_IMAGE = 'GRID_IMAGE'.freeze,
  IMAGE_TYPE_DATABASE_IMAGE = 'DATABASE_IMAGE'.freeze,
  IMAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IMAGE_SHAPE_FAMILY_ENUM = 
[
  IMAGE_SHAPE_FAMILY_VM_BM_SHAPE = 'VM_BM_SHAPE'.freeze,
  IMAGE_SHAPE_FAMILY_EXADATA_SHAPE = 'EXADATA_SHAPE'.freeze,
  IMAGE_SHAPE_FAMILY_EXACC_SHAPE = 'EXACC_SHAPE'.freeze,
  IMAGE_SHAPE_FAMILY_EXADBXS_SHAPE = 'EXADBXS_SHAPE'.freeze,
  IMAGE_SHAPE_FAMILY_BDBCC_SHAPE = 'BDBCC_SHAPE'.freeze,
  IMAGE_SHAPE_FAMILY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseSoftwareImage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :database_version (String) —

    The value to assign to the #database_version property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :image_type (String) —

    The value to assign to the #image_type property

  • :image_shape_family (String) —

    The value to assign to the #image_shape_family property

  • :patch_set (String) —

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

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :database_software_image_included_patches (Array<String>) —

    The value to assign to the #database_software_image_included_patches property

  • :included_patches_summary (String) —

    The value to assign to the #included_patches_summary property

  • :database_software_image_one_off_patches (Array<String>) —

    The value to assign to the #database_software_image_one_off_patches property

  • :ls_inventory (String) —

    The value to assign to the #ls_inventory property

  • :is_upgrade_supported (BOOLEAN) —

    The value to assign to the #is_upgrade_supported property



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/database/models/database_software_image.rb', line 196

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

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

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

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

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

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

  self.image_shape_family = attributes[:'imageShapeFamily'] if attributes[:'imageShapeFamily']

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

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

  self.patch_set = attributes[:'patchSet'] if attributes[:'patchSet']

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

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

  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']

  self.database_software_image_included_patches = attributes[:'databaseSoftwareImageIncludedPatches'] if attributes[:'databaseSoftwareImageIncludedPatches']

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

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

  self.included_patches_summary = attributes[:'includedPatchesSummary'] if attributes[:'includedPatchesSummary']

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

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

  self.database_software_image_one_off_patches = attributes[:'databaseSoftwareImageOneOffPatches'] if attributes[:'databaseSoftwareImageOneOffPatches']

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

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

  self.ls_inventory = attributes[:'lsInventory'] if attributes[:'lsInventory']

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

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

  self.is_upgrade_supported = attributes[:'isUpgradeSupported'] unless attributes[:'isUpgradeSupported'].nil?

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

  self.is_upgrade_supported = attributes[:'is_upgrade_supported'] unless attributes[:'is_upgrade_supported'].nil?
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database/models/database_software_image.rb', line 46

def compartment_id
  @compartment_id
end

#database_software_image_included_patches ⇒ Array<String>

List of one-off patches for Database Homes.

Returns:

  • (Array<String>) 


102
103
104
 
# File 'lib/oci/database/models/database_software_image.rb', line 102

def database_software_image_included_patches
  @database_software_image_included_patches
end

#database_software_image_one_off_patches ⇒ Array<String>

List of one-off patches for Database Homes.

Returns:

  • (Array<String>) 


110
111
112
 
# File 'lib/oci/database/models/database_software_image.rb', line 110

def database_software_image_one_off_patches
  @database_software_image_one_off_patches
end

#database_version ⇒ String

[Required] The database version with which the database software image is to be built.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database/models/database_software_image.rb', line 50

def database_version
  @database_version
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>>) 


92
93
94
 
# File 'lib/oci/database/models/database_software_image.rb', line 92

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the database software image. The name does not have to be unique.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database/models/database_software_image.rb', line 54

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


86
87
88
 
# File 'lib/oci/database/models/database_software_image.rb', line 86

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the database software image.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database/models/database_software_image.rb', line 42

def id
  @id
end

#image_shape_family ⇒ String

[Required] To what shape the image is meant for.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/database/models/database_software_image.rb', line 74

def image_shape_family
  @image_shape_family
end

#image_type ⇒ String

[Required] The type of software image. Can be grid or database.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database/models/database_software_image.rb', line 70

def image_type
  @image_type
end

#included_patches_summary ⇒ String

The patches included in the image and the version of the image.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/database/models/database_software_image.rb', line 106

def included_patches_summary
  @included_patches_summary
end

#is_upgrade_supported ⇒ BOOLEAN

True if this Database software image is supported for Upgrade.

Returns:

  • (BOOLEAN) 


118
119
120
 
# File 'lib/oci/database/models/database_software_image.rb', line 118

def is_upgrade_supported
  @is_upgrade_supported
end

#lifecycle_details ⇒ String

Detailed message for the lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the database software image.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#ls_inventory ⇒ String

The output from the OPatch lsInventory command, which is passed as a string.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/database/models/database_software_image.rb', line 114

def ls_inventory
  @ls_inventory
end

#patch_set ⇒ String

[Required] The PSU or PBP or Release Updates. To get a list of supported versions, use the list_db_versions operation.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/database/models/database_software_image.rb', line 78

def patch_set
  @patch_set
end

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

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


98
99
100
 
# File 'lib/oci/database/models/database_software_image.rb', line 98

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the database software image was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/database/models/database_software_image.rb', line 121

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'database_version': :'databaseVersion',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'image_type': :'imageType',
    'image_shape_family': :'imageShapeFamily',
    'patch_set': :'patchSet',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'database_software_image_included_patches': :'databaseSoftwareImageIncludedPatches',
    'included_patches_summary': :'includedPatchesSummary',
    'database_software_image_one_off_patches': :'databaseSoftwareImageOneOffPatches',
    'ls_inventory': :'lsInventory',
    'is_upgrade_supported': :'isUpgradeSupported'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/database/models/database_software_image.rb', line 147

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'database_version': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'image_type': :'String',
    'image_shape_family': :'String',
    'patch_set': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'database_software_image_included_patches': :'Array<String>',
    'included_patches_summary': :'String',
    'database_software_image_one_off_patches': :'Array<String>',
    'ls_inventory': :'String',
    'is_upgrade_supported': :'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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/database/models/database_software_image.rb', line 350

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    database_version == other.database_version &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    image_type == other.image_type &&
    image_shape_family == other.image_shape_family &&
    patch_set == other.patch_set &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    database_software_image_included_patches == other.database_software_image_included_patches &&
    included_patches_summary == other.included_patches_summary &&
    database_software_image_one_off_patches == other.database_software_image_one_off_patches &&
    ls_inventory == other.ls_inventory &&
    is_upgrade_supported == other.is_upgrade_supported
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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/database/models/database_software_image.rb', line 397

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


377
378
379
 
# File 'lib/oci/database/models/database_software_image.rb', line 377

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



386
387
388
 
# File 'lib/oci/database/models/database_software_image.rb', line 386

def hash
  [id, compartment_id, database_version, display_name, lifecycle_state, lifecycle_details, time_created, image_type, image_shape_family, patch_set, freeform_tags, defined_tags, system_tags, database_software_image_included_patches, included_patches_summary, database_software_image_one_off_patches, ls_inventory, is_upgrade_supported].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/database/models/database_software_image.rb', line 430

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



424
425
426
 
# File 'lib/oci/database/models/database_software_image.rb', line 424

def to_s
  to_hash.to_s
end