Class: OCI::Recovery::Models::CreateProtectedDatabaseDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/recovery/models/create_protected_database_details.rb

Overview

Describes the parameters required to create a protected database.

Constant Summary collapse

DATABASE_SIZE_ENUM = 
[
  DATABASE_SIZE_XS = 'XS'.freeze,
  DATABASE_SIZE_S = 'S'.freeze,
  DATABASE_SIZE_M = 'M'.freeze,
  DATABASE_SIZE_L = 'L'.freeze,
  DATABASE_SIZE_XL = 'XL'.freeze,
  DATABASE_SIZE_XXL = 'XXL'.freeze,
  DATABASE_SIZE_AUTO = 'AUTO'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateProtectedDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 159

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

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

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

  self.database_size = attributes[:'databaseSize'] if attributes[:'databaseSize']

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

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

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

  self.protection_policy_id = attributes[:'protectionPolicyId'] if attributes[:'protectionPolicyId']

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

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

  self.recovery_service_subnets = attributes[:'recoveryServiceSubnets'] if attributes[:'recoveryServiceSubnets']

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

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

  self.database_id = attributes[:'databaseId'] if attributes[:'databaseId']

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

  self.database_id = attributes[:'database_id'] if attributes[:'database_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_size_in_gbs = attributes[:'databaseSizeInGBs'] if attributes[:'databaseSizeInGBs']

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

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

  self.change_rate = attributes[:'changeRate'] if attributes[:'changeRate']

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

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

  self.compression_ratio = attributes[:'compressionRatio'] if attributes[:'compressionRatio']

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

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

  self.is_redo_logs_shipped = attributes[:'isRedoLogsShipped'] unless attributes[:'isRedoLogsShipped'].nil?

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

  self.is_redo_logs_shipped = attributes[:'is_redo_logs_shipped'] unless attributes[:'is_redo_logs_shipped'].nil?

  self.subscription_id = attributes[:'subscriptionId'] if attributes[:'subscriptionId']

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

  self.subscription_id = attributes[:'subscription_id'] if attributes[:'subscription_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']
end

Instance Attribute Details

#change_rate ⇒ Float

The percentage of data changes that exist in the database between successive incremental backups.

Returns:

  • (Float) 


62
63
64
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 62

def change_rate
  @change_rate
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the protected database.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 54

def compartment_id
  @compartment_id
end

#compression_ratio ⇒ Float

The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size.

Returns:

  • (Float) 


66
67
68
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 66

def compression_ratio
  @compression_ratio
end

#database_id ⇒ String

The OCID of the protected database.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 50

def database_id
  @database_id
end

#database_size ⇒ String

The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 31

def database_size
  @database_size
end

#database_size_in_gbs ⇒ Integer

The size of the database, in gigabytes.

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 58

def database_size_in_gbs
  @database_size_in_gbs
end

#db_unique_name ⇒ String

[Required] The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 27

def db_unique_name
  @db_unique_name
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}. For more information, see {Resource Tags}[https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm]

Returns:

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


90
91
92
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 90

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The protected database name. You can change the displayName. Avoid entering confidential information.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 23

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


84
85
86
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 84

def freeform_tags
  @freeform_tags
end

#is_redo_logs_shipped ⇒ BOOLEAN

The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.

Returns:

  • (BOOLEAN) 


72
73
74
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 72

def is_redo_logs_shipped
  @is_redo_logs_shipped
end

#password ⇒ String

[Required] Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username "admin", regardless of casing.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 38

def password
  @password
end

#protection_policy_id ⇒ String

[Required] The OCID of the protection policy associated with the protected database.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 42

def protection_policy_id
  @protection_policy_id
end

#recovery_service_subnets ⇒ Array<OCI::Recovery::Models::RecoveryServiceSubnetInput>

[Required] List of recovery service subnet resources associated with the protected database.

Returns:



46
47
48
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 46

def recovery_service_subnets
  @recovery_service_subnets
end

#subscription_id ⇒ String

The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 78

def subscription_id
  @subscription_id
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'db_unique_name': :'dbUniqueName',
    'database_size': :'databaseSize',
    'password': :'password',
    'protection_policy_id': :'protectionPolicyId',
    'recovery_service_subnets': :'recoveryServiceSubnets',
    'database_id': :'databaseId',
    'compartment_id': :'compartmentId',
    'database_size_in_gbs': :'databaseSizeInGBs',
    'change_rate': :'changeRate',
    'compression_ratio': :'compressionRatio',
    'is_redo_logs_shipped': :'isRedoLogsShipped',
    'subscription_id': :'subscriptionId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 116

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'db_unique_name': :'String',
    'database_size': :'String',
    'password': :'String',
    'protection_policy_id': :'String',
    'recovery_service_subnets': :'Array<OCI::Recovery::Models::RecoveryServiceSubnetInput>',
    'database_id': :'String',
    'compartment_id': :'String',
    'database_size_in_gbs': :'Integer',
    'change_rate': :'Float',
    'compression_ratio': :'Float',
    'is_redo_logs_shipped': :'BOOLEAN',
    'subscription_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 267

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

  self.class == other.class &&
    display_name == other.display_name &&
    db_unique_name == other.db_unique_name &&
    database_size == other.database_size &&
    password == other.password &&
    protection_policy_id == other.protection_policy_id &&
    recovery_service_subnets == other.recovery_service_subnets &&
    database_id == other.database_id &&
    compartment_id == other.compartment_id &&
    database_size_in_gbs == other.database_size_in_gbs &&
    change_rate == other.change_rate &&
    compression_ratio == other.compression_ratio &&
    is_redo_logs_shipped == other.is_redo_logs_shipped &&
    subscription_id == other.subscription_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 311

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


291
292
293
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 291

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 300

def hash
  [display_name, db_unique_name, database_size, password, protection_policy_id, recovery_service_subnets, database_id, compartment_id, database_size_in_gbs, change_rate, compression_ratio, is_redo_logs_shipped, subscription_id, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 344

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



338
339
340
 
# File 'lib/oci/recovery/models/create_protected_database_details.rb', line 338

def to_s
  to_hash.to_s
end