Class: OCI::Database::Models::PluggableDatabaseSummary
- Inherits:
-
Object
- Object
- OCI::Database::Models::PluggableDatabaseSummary
- Defined in:
- lib/oci/database/models/pluggable_database_summary.rb
Overview
A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_RELOCATING = 'RELOCATING'.freeze, LIFECYCLE_STATE_RELOCATED = 'RELOCATED'.freeze, LIFECYCLE_STATE_REFRESHING = 'REFRESHING'.freeze, LIFECYCLE_STATE_RESTORE_IN_PROGRESS = 'RESTORE_IN_PROGRESS'.freeze, LIFECYCLE_STATE_RESTORE_FAILED = 'RESTORE_FAILED'.freeze, LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'.freeze, LIFECYCLE_STATE_DISABLED = 'DISABLED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- OPEN_MODE_ENUM =
[ OPEN_MODE_READ_ONLY = 'READ_ONLY'.freeze, OPEN_MODE_READ_WRITE = 'READ_WRITE'.freeze, OPEN_MODE_MOUNTED = 'MOUNTED'.freeze, OPEN_MODE_MIGRATE = 'MIGRATE'.freeze, OPEN_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
- #connection_strings ⇒ OCI::Database::Models::PluggableDatabaseConnectionStrings
-
#container_database_id ⇒ String
[Required] The OCID of the CDB.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the pluggable database.
-
#is_restricted ⇒ BOOLEAN
The restricted mode of the pluggable database.
-
#lifecycle_details ⇒ String
Detailed message for the lifecycle state.
-
#lifecycle_state ⇒ String
[Required] The current state of the pluggable database.
-
#open_mode ⇒ String
[Required] Deprecated. Use pluggable_database_node_level_details for OpenMode details.
-
#pdb_name ⇒ String
[Required] The name for the pluggable database (PDB).
-
#pdb_node_level_details ⇒ Array<OCI::Database::Models::PluggableDatabaseNodeLevelDetails>
Pluggable Database Node Level Details.
- #pluggable_database_management_config ⇒ OCI::Database::Models::PluggableDatabaseManagementConfig
- #refreshable_clone_config ⇒ OCI::Database::Models::PluggableDatabaseRefreshableCloneConfig
-
#time_created ⇒ DateTime
[Required] The date and time the pluggable database was created.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PluggableDatabaseSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ PluggableDatabaseSummary
Initializes the object
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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 177 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.id = attributes[:'id'] if attributes[:'id'] 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_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.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.connection_strings = attributes[:'connectionStrings'] if attributes[:'connectionStrings'] raise 'You cannot provide both :connectionStrings and :connection_strings' if attributes.key?(:'connectionStrings') && attributes.key?(:'connection_strings') self.connection_strings = attributes[:'connection_strings'] if attributes[:'connection_strings'] self.open_mode = attributes[:'openMode'] if attributes[:'openMode'] raise 'You cannot provide both :openMode and :open_mode' if attributes.key?(:'openMode') && attributes.key?(:'open_mode') self.open_mode = attributes[:'open_mode'] if attributes[:'open_mode'] self.is_restricted = attributes[:'isRestricted'] unless attributes[:'isRestricted'].nil? raise 'You cannot provide both :isRestricted and :is_restricted' if attributes.key?(:'isRestricted') && attributes.key?(:'is_restricted') self.is_restricted = attributes[:'is_restricted'] unless attributes[:'is_restricted'].nil? 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.pluggable_database_management_config = attributes[:'pluggableDatabaseManagementConfig'] if attributes[:'pluggableDatabaseManagementConfig'] raise 'You cannot provide both :pluggableDatabaseManagementConfig and :pluggable_database_management_config' if attributes.key?(:'pluggableDatabaseManagementConfig') && attributes.key?(:'pluggable_database_management_config') self.pluggable_database_management_config = attributes[:'pluggable_database_management_config'] if attributes[:'pluggable_database_management_config'] self.refreshable_clone_config = attributes[:'refreshableCloneConfig'] if attributes[:'refreshableCloneConfig'] raise 'You cannot provide both :refreshableCloneConfig and :refreshable_clone_config' if attributes.key?(:'refreshableCloneConfig') && attributes.key?(:'refreshable_clone_config') self.refreshable_clone_config = attributes[:'refreshable_clone_config'] if attributes[:'refreshable_clone_config'] self.pdb_node_level_details = attributes[:'pdbNodeLevelDetails'] if attributes[:'pdbNodeLevelDetails'] raise 'You cannot provide both :pdbNodeLevelDetails and :pdb_node_level_details' if attributes.key?(:'pdbNodeLevelDetails') && attributes.key?(:'pdb_node_level_details') self.pdb_node_level_details = attributes[:'pdb_node_level_details'] if attributes[:'pdb_node_level_details'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment.
82 83 84 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 82 def compartment_id @compartment_id end |
#connection_strings ⇒ OCI::Database::Models::PluggableDatabaseConnectionStrings
66 67 68 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 66 def connection_strings @connection_strings end |
#container_database_id ⇒ String
[Required] The OCID of the CDB.
47 48 49 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 47 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.
96 97 98 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 96 def @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\"}
90 91 92 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 90 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the pluggable database.
43 44 45 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 43 def id @id end |
#is_restricted ⇒ BOOLEAN
The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
78 79 80 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 78 def is_restricted @is_restricted end |
#lifecycle_details ⇒ String
Detailed message for the lifecycle state.
59 60 61 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 59 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the pluggable database.
55 56 57 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 55 def lifecycle_state @lifecycle_state end |
#open_mode ⇒ String
[Required] Deprecated. Use pluggable_database_node_level_details for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
72 73 74 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 72 def open_mode @open_mode 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.
51 52 53 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 51 def pdb_name @pdb_name end |
#pdb_node_level_details ⇒ Array<OCI::Database::Models::PluggableDatabaseNodeLevelDetails>
Pluggable Database Node Level Details. Example: [: "node1", "openMode" : "READ_WRITE", : "node2", "openMode" : "READ_ONLY"]
108 109 110 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 108 def pdb_node_level_details @pdb_node_level_details end |
#pluggable_database_management_config ⇒ OCI::Database::Models::PluggableDatabaseManagementConfig
99 100 101 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 99 def pluggable_database_management_config @pluggable_database_management_config end |
#refreshable_clone_config ⇒ OCI::Database::Models::PluggableDatabaseRefreshableCloneConfig
102 103 104 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 102 def refreshable_clone_config @refreshable_clone_config end |
#time_created ⇒ DateTime
[Required] The date and time the pluggable database was created.
63 64 65 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 63 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 111 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'container_database_id': :'containerDatabaseId', 'pdb_name': :'pdbName', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'time_created': :'timeCreated', 'connection_strings': :'connectionStrings', 'open_mode': :'openMode', 'is_restricted': :'isRestricted', 'compartment_id': :'compartmentId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'pluggable_database_management_config': :'pluggableDatabaseManagementConfig', 'refreshable_clone_config': :'refreshableCloneConfig', 'pdb_node_level_details': :'pdbNodeLevelDetails' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 134 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'container_database_id': :'String', 'pdb_name': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'time_created': :'DateTime', 'connection_strings': :'OCI::Database::Models::PluggableDatabaseConnectionStrings', 'open_mode': :'String', 'is_restricted': :'BOOLEAN', 'compartment_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'pluggable_database_management_config': :'OCI::Database::Models::PluggableDatabaseManagementConfig', 'refreshable_clone_config': :'OCI::Database::Models::PluggableDatabaseRefreshableCloneConfig', 'pdb_node_level_details': :'Array<OCI::Database::Models::PluggableDatabaseNodeLevelDetails>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 303 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && container_database_id == other.container_database_id && pdb_name == other.pdb_name && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && time_created == other.time_created && connection_strings == other.connection_strings && open_mode == other.open_mode && is_restricted == other.is_restricted && compartment_id == other.compartment_id && == other. && == other. && pluggable_database_management_config == other.pluggable_database_management_config && refreshable_clone_config == other.refreshable_clone_config && pdb_node_level_details == other.pdb_node_level_details end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 347 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
327 328 329 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 327 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
336 337 338 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 336 def hash [id, container_database_id, pdb_name, lifecycle_state, lifecycle_details, time_created, connection_strings, open_mode, is_restricted, compartment_id, , , pluggable_database_management_config, refreshable_clone_config, pdb_node_level_details].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
380 381 382 383 384 385 386 387 388 389 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 380 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
374 375 376 |
# File 'lib/oci/database/models/pluggable_database_summary.rb', line 374 def to_s to_hash.to_s end |