Class: OCI::Database::Models::CreatePluggableDatabaseDetails

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

Overview

Parameters for creating a pluggable database in a specified container database (CDB). Additional option pdbCreationTypeDetails can be used for creating Pluggable Database using different operations, e.g. LocalClone, Remote Clone, Relocate. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePluggableDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 113

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

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

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

  self.container_database_id = attributes[:'containerDatabaseId'] if attributes[:'containerDatabaseId']

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

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

  self.pdb_admin_password = attributes[:'pdbAdminPassword'] if attributes[:'pdbAdminPassword']

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

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

  self.tde_wallet_password = attributes[:'tdeWalletPassword'] if attributes[:'tdeWalletPassword']

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

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

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

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

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

  self.container_database_admin_password = attributes[:'containerDatabaseAdminPassword'] if attributes[:'containerDatabaseAdminPassword']

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

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

  self.should_create_pdb_backup = attributes[:'shouldCreatePdbBackup'] unless attributes[:'shouldCreatePdbBackup'].nil?

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

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

  self.pdb_creation_type_details = attributes[:'pdbCreationTypeDetails'] if attributes[:'pdbCreationTypeDetails']

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

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

  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

#container_database_admin_password ⇒ String

The DB system administrator password of the Container Database.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 38

def container_database_admin_password
  @container_database_admin_password
end

#container_database_id ⇒ String

[Required] The OCID of the CDB

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 20

def container_database_id
  @container_database_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>>) 


59
60
61
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 59

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


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

def freeform_tags
  @freeform_tags
end

#pdb_admin_password ⇒ String

A strong password for PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

Returns:

  • (String) 


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

def pdb_admin_password
  @pdb_admin_password
end

#pdb_creation_type_details ⇒ OCI::Database::Models::CreatePluggableDatabaseCreationTypeDetails

Returns:



45
46
47
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 45

def pdb_creation_type_details
  @pdb_creation_type_details
end

#pdb_name ⇒ String

[Required] The name for the pluggable database (PDB). The name is unique in the context of a Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 16

def pdb_name
  @pdb_name
end

#should_create_pdb_backup ⇒ BOOLEAN

Indicates whether to take Pluggable Database Backup after the operation.

Returns:

  • (BOOLEAN) 


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

def should_create_pdb_backup
  @should_create_pdb_backup
end

#should_pdb_admin_account_be_locked ⇒ BOOLEAN

The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.

Returns:

  • (BOOLEAN) 


34
35
36
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 34

def 
  @should_pdb_admin_account_be_locked
end

#tde_wallet_password ⇒ String

The existing TDE wallet password of the CDB.

Returns:

  • (String) 


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

def tde_wallet_password
  @tde_wallet_password
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'pdb_name': :'pdbName',
    'container_database_id': :'containerDatabaseId',
    'pdb_admin_password': :'pdbAdminPassword',
    'tde_wallet_password': :'tdeWalletPassword',
    'should_pdb_admin_account_be_locked': :'shouldPdbAdminAccountBeLocked',
    'container_database_admin_password': :'containerDatabaseAdminPassword',
    'should_create_pdb_backup': :'shouldCreatePdbBackup',
    'pdb_creation_type_details': :'pdbCreationTypeDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'pdb_name': :'String',
    'container_database_id': :'String',
    'pdb_admin_password': :'String',
    'tde_wallet_password': :'String',
    'should_pdb_admin_account_be_locked': :'BOOLEAN',
    'container_database_admin_password': :'String',
    'should_create_pdb_backup': :'BOOLEAN',
    'pdb_creation_type_details': :'OCI::Database::Models::CreatePluggableDatabaseCreationTypeDetails',
    '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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 189

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

  self.class == other.class &&
    pdb_name == other.pdb_name &&
    container_database_id == other.container_database_id &&
    pdb_admin_password == other.pdb_admin_password &&
    tde_wallet_password == other.tde_wallet_password &&
     == other. &&
    container_database_admin_password == other.container_database_admin_password &&
    should_create_pdb_backup == other.should_create_pdb_backup &&
    pdb_creation_type_details == other.pdb_creation_type_details &&
    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



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/database/models/create_pluggable_database_details.rb', line 228

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


208
209
210
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 208

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 217

def hash
  [pdb_name, container_database_id, pdb_admin_password, tde_wallet_password, , container_database_admin_password, should_create_pdb_backup, pdb_creation_type_details, 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



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 261

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



255
256
257
 
# File 'lib/oci/database/models/create_pluggable_database_details.rb', line 255

def to_s
  to_hash.to_s
end