Class: OCI::Database::Models::UpdateAutonomousDatabaseDetails

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

Overview

Details to update an Oracle Autonomous Database.

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

Constant Summary collapse

LICENSE_MODEL_ENUM = 
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateAutonomousDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cpu_core_count (Integer) —

    The value to assign to the #cpu_core_count property

  • :data_storage_size_in_tbs (Integer) —

    The value to assign to the #data_storage_size_in_tbs property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :is_free_tier (BOOLEAN) —

    The value to assign to the #is_free_tier property

  • :admin_password (String) —

    The value to assign to the #admin_password property

  • :db_name (String) —

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

  • :license_model (String) —

    The value to assign to the #license_model property

  • :whitelisted_ips (Array<String>) —

    The value to assign to the #whitelisted_ips property

  • :is_auto_scaling_enabled (BOOLEAN) —

    The value to assign to the #is_auto_scaling_enabled property



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
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 131

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

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

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

  self.data_storage_size_in_tbs = attributes[:'dataStorageSizeInTBs'] if attributes[:'dataStorageSizeInTBs']

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

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

  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.is_free_tier = attributes[:'isFreeTier'] unless attributes[:'isFreeTier'].nil?
  self.is_free_tier = false if is_free_tier.nil? && !attributes.key?(:'isFreeTier') # rubocop:disable Style/StringLiterals

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

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

  self.admin_password = attributes[:'adminPassword'] if attributes[:'adminPassword']

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

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

  self.db_name = attributes[:'dbName'] if attributes[:'dbName']

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

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

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

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

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

  self.whitelisted_ips = attributes[:'whitelistedIps'] if attributes[:'whitelistedIps']

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

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

  self.is_auto_scaling_enabled = attributes[:'isAutoScalingEnabled'] unless attributes[:'isAutoScalingEnabled'].nil?

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

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

Instance Attribute Details

#admin_password ⇒ String

The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 37

def admin_password
  @admin_password
end

#cpu_core_count ⇒ Integer

The number of CPU cores to be made available to the database.

Returns:

  • (Integer) 


19
20
21
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 19

def cpu_core_count
  @cpu_core_count
end

#data_storage_size_in_tbs ⇒ Integer

The size, in terabytes, of the data volume that will be attached to the database.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 24

def data_storage_size_in_tbs
  @data_storage_size_in_tbs
end

#db_name ⇒ String

New name for this Autonomous Database. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. This is valid only for dedicated databases.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 44

def db_name
  @db_name
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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Returns:

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 28

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


52
53
54
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 52

def freeform_tags
  @freeform_tags
end

#is_auto_scaling_enabled ⇒ BOOLEAN

Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is false. Note that auto scaling is available for [serverless deployments](docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI) only.

Returns:

  • (BOOLEAN) 


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

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_free_tier ⇒ BOOLEAN

Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB memory. For Always Free databases, memory and CPU cannot be scaled.

Returns:

  • (BOOLEAN) 


33
34
35
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 33

def is_free_tier
  @is_free_tier
end

#license_model ⇒ String

The Oracle license model that applies to the Oracle Autonomous Database. The default for Autonomous Database using the [shared deployment] is BRING_YOUR_OWN_LICENSE. Note that when provisioning an Autonomous Database using the [dedicated deployment](docs.cloud.oracle.com/Content/Database/Concepts/adbddoverview.htm) option, this attribute must be null because the attribute is already set on Autonomous Exadata Infrastructure level.

Returns:

  • (String) 


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

def license_model
  @license_model
end

#whitelisted_ips ⇒ Array<String>

The client IP access control list (ACL). This feature is available for [serverless deployments](docs.cloud.oracle.com/Content/Database/Concepts/adboverview.htm#AEI) only. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. This is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet. To delete all the existing white listed IPu2019s, use an array with a single empty string entry.

Returns:

  • (Array<String>) 


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

def whitelisted_ips
  @whitelisted_ips
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cpu_core_count': :'cpuCoreCount',
    'data_storage_size_in_tbs': :'dataStorageSizeInTBs',
    'display_name': :'displayName',
    'is_free_tier': :'isFreeTier',
    'admin_password': :'adminPassword',
    'db_name': :'dbName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'license_model': :'licenseModel',
    'whitelisted_ips': :'whitelistedIps',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cpu_core_count': :'Integer',
    'data_storage_size_in_tbs': :'Integer',
    'display_name': :'String',
    'is_free_tier': :'BOOLEAN',
    'admin_password': :'String',
    'db_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'license_model': :'String',
    'whitelisted_ips': :'Array<String>',
    'is_auto_scaling_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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 221

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

  self.class == other.class &&
    cpu_core_count == other.cpu_core_count &&
    data_storage_size_in_tbs == other.data_storage_size_in_tbs &&
    display_name == other.display_name &&
    is_free_tier == other.is_free_tier &&
    admin_password == other.admin_password &&
    db_name == other.db_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    license_model == other.license_model &&
    whitelisted_ips == other.whitelisted_ips &&
    is_auto_scaling_enabled == other.is_auto_scaling_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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 261

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


241
242
243
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 241

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [cpu_core_count, data_storage_size_in_tbs, display_name, is_free_tier, admin_password, db_name, freeform_tags, defined_tags, license_model, whitelisted_ips, is_auto_scaling_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 294

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



288
289
290
 
# File 'lib/oci/database/models/update_autonomous_database_details.rb', line 288

def to_s
  to_hash.to_s
end