Class: OCI::Database::Models::CreateDatabaseSoftwareImageDetails

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

Overview

Parameters for creating a database software image in the specified compartment.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

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
].freeze
IMAGE_TYPE_ENUM =
[
  IMAGE_TYPE_GRID_IMAGE = 'GRID_IMAGE'.freeze,
  IMAGE_TYPE_DATABASE_IMAGE = 'DATABASE_IMAGE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseSoftwareImageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :image_shape_family (String)

    The value to assign to the #image_shape_family property

  • :image_type (String)

    The value to assign to the #image_type property

  • :patch_set (String)

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

  • :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_db_home_id (String)

    The value to assign to the #source_db_home_id property



130
131
132
133
134
135
136
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
196
197
198
199
200
201
202
203
204
205
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 130

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.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.image_shape_family = attributes[:'imageShapeFamily'] if attributes[:'imageShapeFamily']
  self.image_shape_family = "VM_BM_SHAPE" if image_shape_family.nil? && !attributes.key?(:'imageShapeFamily') # rubocop:disable Style/StringLiterals

  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.image_shape_family = "VM_BM_SHAPE" if image_shape_family.nil? && !attributes.key?(:'imageShapeFamily') && !attributes.key?(:'image_shape_family') # rubocop:disable Style/StringLiterals

  self.image_type = attributes[:'imageType'] if attributes[:'imageType']
  self.image_type = "DATABASE_IMAGE" if image_type.nil? && !attributes.key?(:'imageType') # rubocop:disable Style/StringLiterals

  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_type = "DATABASE_IMAGE" if image_type.nil? && !attributes.key?(:'imageType') && !attributes.key?(:'image_type') # rubocop:disable Style/StringLiterals

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

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

  self.source_db_home_id = attributes[:'source_db_home_id'] if attributes[:'source_db_home_id']
end

Instance Attribute Details

#compartment_idString

[Required] The OCID of the compartment the database software image belongs in.

Returns:

  • (String)


27
28
29
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 27

def compartment_id
  @compartment_id
end

#database_software_image_one_off_patchesArray<String>

List of one-off patches for Database Homes.

Returns:

  • (Array<String>)


51
52
53
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 51

def database_software_image_one_off_patches
  @database_software_image_one_off_patches
end

#database_versionString

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

Returns:

  • (String)


31
32
33
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 31

def database_version
  @database_version
end

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


69
70
71
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 69

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

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


63
64
65
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 63

def freeform_tags
  @freeform_tags
end

#image_shape_familyString

To what shape the image is meant for.

Returns:

  • (String)


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

def image_shape_family
  @image_shape_family
end

#image_typeString

The type of software image. Can be grid or database.

Returns:

  • (String)


43
44
45
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 43

def image_type
  @image_type
end

#ls_inventoryString

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

Returns:

  • (String)


55
56
57
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 55

def ls_inventory
  @ls_inventory
end

#patch_setString

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

Returns:

  • (String)


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

def patch_set
  @patch_set
end

#source_db_home_idString

The OCID of the Database Home.

Returns:

  • (String)


73
74
75
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 73

def source_db_home_id
  @source_db_home_id
end

Class Method Details

.attribute_mapObject

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'database_version': :'databaseVersion',
    'display_name': :'displayName',
    'image_shape_family': :'imageShapeFamily',
    'image_type': :'imageType',
    'patch_set': :'patchSet',
    'database_software_image_one_off_patches': :'databaseSoftwareImageOneOffPatches',
    'ls_inventory': :'lsInventory',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'source_db_home_id': :'sourceDbHomeId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'database_version': :'String',
    'display_name': :'String',
    'image_shape_family': :'String',
    'image_type': :'String',
    'patch_set': :'String',
    'database_software_image_one_off_patches': :'Array<String>',
    'ls_inventory': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'source_db_home_id': :'String'
    # 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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 230

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    database_version == other.database_version &&
    display_name == other.display_name &&
    image_shape_family == other.image_shape_family &&
    image_type == other.image_type &&
    patch_set == other.patch_set &&
    database_software_image_one_off_patches == other.database_software_image_one_off_patches &&
    ls_inventory == other.ls_inventory &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    source_db_home_id == other.source_db_home_id
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 270

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


250
251
252
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 250

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



259
260
261
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 259

def hash
  [compartment_id, database_version, display_name, image_shape_family, image_type, patch_set, database_software_image_one_off_patches, ls_inventory, freeform_tags, defined_tags, source_db_home_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



303
304
305
306
307
308
309
310
311
312
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 303

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



297
298
299
# File 'lib/oci/database/models/create_database_software_image_details.rb', line 297

def to_s
  to_hash.to_s
end